diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000000000000000000000000000000000000..8b5c6187184da2b5d0401d5129544f6782540f3c --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +protoc/ +go-stubs/ +ruby-stubs/ +.proto-gen/ +python-stubs/ +.vscode/ \ No newline at end of file diff --git a/MEC030_V2XInformationService.json b/MEC030_V2XInformationService.json deleted file mode 100644 index b172b7e18fb17300d7344c06d40f4ed8bf1e453c..0000000000000000000000000000000000000000 --- a/MEC030_V2XInformationService.json +++ /dev/null @@ -1,2034 +0,0 @@ -{ - "openapi": "3.1.0", - "info": { - "title": "ETSI GS MEC 030 V2X Information Service API", - "version": "2.1.9", - "description": "ETSI GS MEC 030 V2X Information Service API described using OpenAPI.", - "contact": { - "name": "ETSI Forge", - "email": "cti_support@etsi.org", - "url": "https://forge.etsi.org/rep/mec/gs030-vis-api" - }, - "license": { - "name": "BSD-3-Clause", - "url": "https://forge.etsi.org/legal-matters" - } - }, - "externalDocs": { - "description": "ETSI GS MEC 030 V2X Information Service API, v2.1.9", - "url": "" - }, - "servers": [{ - "url": "https://localhost/vis/v2" - }], - "tags": [{ - "name": "queries", - "description": "Queries" - }, - { - "name": "subscription", - "description": "Subscription" - }, - { - "name": "QoS" - }, - { - "name": "V2X_msg" - } - ], - "paths": { - "/queries/uu_unicast_provisioning_info": { - "get": { - "tags": [ - "queries" - ], - "summary": "Used to query provisioning information for V2X communication over Uu unicast.", - "description": "Used to query provisioning information for V2X communication over Uu unicast.", - "operationId": "prov_info_uu_unicastGET", - "parameters": [{ - "in": "query", - "name": "location_info", - "schema": { - "type": "string" - }, - "required": true, - "description": "Comma separated list of locations to identify a cell of a base station or a particular geographical area" - }], - "responses": { - "200": { - "description": "A response body containing the Uu unicast provisioning information. ", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UuUnicastProvisioningInfo" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "406": { - "$ref": "#/components/responses/406" - }, - "429": { - "$ref": "#/components/responses/429" - } - } - } - }, - "/queries/uu_mbms_provisioning_info": { - "get": { - "tags": [ - "queries" - ], - "summary": "retrieve information required for V2X communication over Uu MBMS.", - "description": "retrieve information required for V2X communication over Uu MBMS.", - "operationId": "prov_info_uu_mbmsGET", - "parameters": [{ - "in": "query", - "name": "location_info", - "schema": { - "type": "string" - }, - "required": true, - "description": "omma separated list of locations to identify a cell of a base station or a particular geographical area" - }], - "responses": { - "200": { - "description": "A response body containing the Uu unicast provisioning information. ", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UuMbmsProvisioningInfo" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "406": { - "$ref": "#/components/responses/406" - }, - "429": { - "$ref": "#/components/responses/429" - } - } - } - }, - "/queries/pc5_provisioning_info": { - "get": { - "tags": [ - "queries" - ], - "summary": "Query provisioning information for V2X communication over PC5.", - "description": "Query provisioning information for V2X communication over PC5.", - "operationId": "prov_infoGET", - "parameters": [{ - "in": "query", - "name": "location_info", - "schema": { - "type": "string" - }, - "required": true, - "description": "Comma separated list of locations to identify a cell of a base station or a particular geographical area" - }], - "responses": { - "200": { - "description": "A response body containing the PC5 provisioning information is returned.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Pc5ProvisioningInfo" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "406": { - "$ref": "#/components/responses/406" - }, - "429": { - "$ref": "#/components/responses/429" - } - } - } - }, - "/provide_predicted_qos": { - "post": { - "tags": [ - "QoS" - ], - "summary": "Request the predicted QoS correspondent to potential routes of a vehicular UE.", - "description": "Request the predicted QoS correspondent to potential routes of a vehicular UE.", - "operationId": "predicted_qosPOST", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PredictedQos" - } - } - } - }, - "responses": { - "200": { - "description": "The response body shall contain the predicted QoS corresponding to potential routes of a vehicular UE", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/PredictedQos" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - } - } - } - }, - "/publish_v2x_message": { - "post": { - "tags": [ - "V2X_msg" - ], - "summary": "Used to publish a V2X message.", - "description": "Used to publish a V2X message.", - "operationId": "v2x_messagePOST", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/V2xMsgPublication" - } - } - } - }, - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "406": { - "$ref": "#/components/responses/406" - }, - "429": { - "$ref": "#/components/responses/429" - } - } - } - }, - "/subscriptions": { - "get": { - "tags": [ - "subscription" - ], - "summary": "Request information about the subscriptions for this requestor.", - "description": "Request information about the subscriptions for this requestor.", - "operationId": "subGET", - "parameters": [{ - "in": "query", - "name": "subscription_type", - "description": "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", - "schema": { - "type": "string" - }, - "required": false - }], - "responses": { - "200": { - "description": "A response body containing the list of links to requestor subscriptions is returned.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SubscriptionLinkList" - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "406": { - "$ref": "#/components/responses/406" - }, - "429": { - "$ref": "#/components/responses/429" - } - } - }, - "post": { - "tags": [ - "subscription" - ], - "summary": " create a new subscription to VIS notifications.", - "description": " create a new subscription to VIS notifications.", - "operationId": "subPOST", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "oneOf": [{ - "$ref": "#/components/schemas/ProvChgUuUniSubscription" - }, - { - "$ref": "#/components/schemas/ProvChgUuMbmsSubscription" - }, - { - "$ref": "#/components/schemas/ProvChgPc5Subscription" - }, - { - "$ref": "#/components/schemas/V2xMsgSubscription" - } - ] - } - } - } - }, - "responses": { - "201": { - "description": "In the returned NotificationSubscription structure, the created subscription is described using the appropriate data type.", - "content": { - "application/json": { - "schema": { - "oneOf": [{ - "$ref": "#/components/schemas/ProvChgUuUniSubscription" - }, - { - "$ref": "#/components/schemas/ProvChgUuMbmsSubscription" - }, - { - "$ref": "#/components/schemas/ProvChgPc5Subscription" - }, - { - "$ref": "#/components/schemas/V2xMsgSubscription" - } - ] - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "406": { - "$ref": "#/components/responses/406" - }, - "415": { - "$ref": "#/components/responses/415" - }, - "422": { - "$ref": "#/components/responses/422" - }, - "429": { - "$ref": "#/components/responses/429" - } - }, - "callbacks": { - "notification": { - "{$request.body#/callbackReference}": { - "post": { - "summary": "Callback POST used to send a notification", - "description": "A notification from VIS.", - "operationId": "notificationPOST", - "requestBody": { - "description": "Subscription notification", - "required": true, - "content": { - "application/json": { - "schema": { - "oneOf": [{ - "$ref": "#/components/schemas/ProvChgUuUniNotification" - }, - { - "$ref": "#/components/schemas/ProvChgUuMbmsNotification" - }, - { - "$ref": "#/components/schemas/ProvChgPc5Notification" - }, - { - "$ref": "#/components/schemas/V2xMsgNotification" - } - ] - } - } - } - }, - "responses": { - "204": { - "$ref": "#/components/responses/204" - } - } - } - } - } - } - } - }, - "/subscriptions/{subscriptionId}": { - "parameters": [{ - "in": "path", - "name": "subscriptionId", - "description": "Refers to created subscription, where the VIS API allocates a unique resource name for this subscription", - "schema": { - "type": "string" - }, - "required": true - }], - "get": { - "tags": [ - "subscription" - ], - "summary": "Retrieve information about this subscription.", - "description": "Retrieve information about this subscription.", - "operationId": "individualSubscriptionGET", - "responses": { - "200": { - "description": "A response body containing the data type describing the specific RNI event subscription is returned", - "content": { - "application/json": { - "schema": { - "oneOf": [{ - "$ref": "#/components/schemas/ProvChgUuUniSubscription" - }, - { - "$ref": "#/components/schemas/ProvChgUuMbmsSubscription" - }, - { - "$ref": "#/components/schemas/ProvChgPc5Subscription" - }, - { - "$ref": "#/components/schemas/V2xMsgSubscription" - } - ] - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "406": { - "$ref": "#/components/responses/406" - }, - "429": { - "$ref": "#/components/responses/429" - } - } - }, - "put": { - "tags": [ - "subscription" - ], - "summary": "Used to update the existing subscription.", - "description": "Used to update the existing subscription.", - "operationId": "individualSubscriptionPUT", - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "oneOf": [{ - "$ref": "#/components/schemas/ProvChgUuUniSubscription" - }, - { - "$ref": "#/components/schemas/ProvChgUuMbmsSubscription" - }, - { - "$ref": "#/components/schemas/ProvChgPc5Subscription" - }, - { - "$ref": "#/components/schemas/V2xMsgSubscription" - } - ] - } - } - } - }, - "responses": { - "200": { - "description": "A response body containing data type describing the updated subscription is returned", - "content": { - "application/json": { - "schema": { - "oneOf": [{ - "$ref": "#/components/schemas/ProvChgUuUniSubscription" - }, - { - "$ref": "#/components/schemas/ProvChgUuMbmsSubscription" - }, - { - "$ref": "#/components/schemas/ProvChgPc5Subscription" - }, - { - "$ref": "#/components/schemas/V2xMsgSubscription" - } - ] - } - } - } - }, - "400": { - "$ref": "#/components/responses/400" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "406": { - "$ref": "#/components/responses/406" - }, - "412": { - "$ref": "#/components/responses/412" - }, - "422": { - "$ref": "#/components/responses/422" - }, - "429": { - "$ref": "#/components/responses/429" - } - } - }, - "delete": { - "tags": [ - "subscription" - ], - "summary": "Used to cancel the existing subscription.", - "description": "Used to cancel the existing subscription.", - "operationId": "individualSubscriptionDELETE", - "responses": { - "204": { - "$ref": "#/components/responses/204" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "403": { - "$ref": "#/components/responses/403" - }, - "404": { - "$ref": "#/components/responses/404" - }, - "429": { - "$ref": "#/components/responses/429" - } - } - } - } - }, - "components": { - "schemas": { - "CellId": { - "properties": { - "cellId": { - "description": "E-UTRAN Cell Identity as a bit string (size (28)).", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" - } - }, - "required": [ - "cellId" - ], - "type": "object", - "x-etsi-ref": "6.6.2" - }, - "Earfcn": { - "properties": { - "earfcn": { - "description": "E-UTRA Absolute Radio Frequency Channel Number, range (0... 65535)", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Integer" - } - }, - "required": [ - "earfcn" - ], - "type": "object", - "x-etsi-ref": "6.6.3" - }, - "Ecgi": { - "properties": { - "cellId": { - "$ref": "#/components/schemas/CellId" - }, - "plmn": { - "$ref": "#/components/schemas/Plmn" - } - }, - "required": [ - "plmn", - "cellId" - ], - "type": "object", - "x-etsi-ref": "6.5.5" - }, - "FddInfo": { - "properties": { - "dlEarfcn": { - "$ref": "#/components/schemas/Earfcn" - }, - "dlTransmissionBandwidth": { - "$ref": "#/components/schemas/TransmissionBandwidth" - }, - "ulEarfcn": { - "$ref": "#/components/schemas/Earfcn" - }, - "ulTransmissionBandwidth": { - "$ref": "#/components/schemas/TransmissionBandwidth" - } - }, - "required": [ - "ulEarfcn", - "dlEarfcn", - "ulTransmissionBandwidth", - "dlTransmissionBandwidth" - ], - "type": "object", - "x-etsi-ref": "6.5.6" - }, - "links": { - "description": "Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.", - "properties": { - "self": { - "$ref": "#/components/schemas/LinkType" - } - }, - "required": [ - "self" - ], - "type": "object", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Structure (inlined)" - }, - "LinkType": { - "properties": { - "href": { - "description": "URI referring to a resource", - "format": "uri", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uri" - } - }, - "required": [ - "href" - ], - "type": "object", - "x-etsi-ref": "6.5.13" - }, - "LocationInfo": { - "properties": { - "ecgi": { - "$ref": "#/components/schemas/Ecgi" - }, - "geoArea": { - "$ref": "#/components/schemas/LocationInfo.geoArea" - } - }, - "type": "object", - "x-etsi-notes": "NOTE:\tEither ecgi or geoArea shall be present, but not both.", - "x-etsi-ref": "6.5.3" - }, - "LocationInfo.geoArea": { - "description": "Information of a geographical area.", - "properties": { - "latitude": { - "description": "Latitude (DATUM = WGS84) -90 to 90 in decimal degree format DDD.ddd", - "format": "float", - "type": "number", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Float" - }, - "longitude": { - "description": "Longitude (DATUM = WGS84) -180 to 180 in decimal degree format DDD.ddd", - "format": "float", - "type": "number", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Float" - } - }, - "required": [ - "latitude", - "longitude" - ], - "type": "object", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Structure (inlined)" - }, - "Pc5NeighbourCellInfo": { - "properties": { - "ecgi": { - "$ref": "#/components/schemas/Ecgi" - }, - "plmn": { - "$ref": "#/components/schemas/Plmn" - }, - "siV2xConfig": { - "$ref": "#/components/schemas/SystemInformationBlockType21" - } - }, - "required": [ - "plmn", - "ecgi", - "siV2xConfig" - ], - "type": "object", - "x-etsi-ref": "6.5.12" - }, - "Pc5ProvisioningInfo": { - "properties": { - "proInfoPc5": { - "type": "array", - "minItems": 1, - "items": { - "$ref": "#/components/schemas/Pc5ProvisioningInfo.proInfoPc5" - } - }, - "timeStamp": { - "$ref": "#/components/schemas/TimeStamp" - } - }, - "required": [ - "proInfoPc5" - ], - "type": "object", - "x-etsi-ref": "6.2.4" - }, - "Pc5ProvisioningInfo.proInfoPc5": { - "description": "The provisioning information per location as defined below.", - "type": "object", - "properties": { - "dstLayer2Id": { - "description": "For sidelink communication, the Destination Layer-2 ID is set to the ProSe Layer-2 Group ID or Prose UE ID, see ETSI TS 136 321 [i.12].\nPLMN operators coordinate to make sure Destination Layer2 ID(s) for different V2X services are configured in a consistent manner.", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" - }, - "locationInfo": { - "$ref": "#/components/schemas/LocationInfo" - }, - "neighbourCellInfo": { - "description": "The information of the neighbour cells in a visiting PLMN that support V2X communication over PC5.", - "items": { - "$ref": "#/components/schemas/Pc5NeighbourCellInfo" - }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "Pc5NeighbourCellInfo" - } - }, - "required": [ - "locationInfo", - "dstLayer2Id" - ], - "x-etsi-mec-cardinality": "1..N", - "x-etsi-mec-origin-type": "Structure (inlined)" - }, - "Plmn": { - "properties": { - "mcc": { - "description": "The Mobile Country Code part of PLMN Identity.", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" - }, - "mnc": { - "description": "The Mobile Network Code part of PLMN Identity.", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" - } - }, - "required": [ - "mcc", - "mnc" - ], - "type": "object", - "x-etsi-ref": "6.5.4" - }, - "PredictedQos": { - "properties": { - "locationGranularity": { - "description": "Granularity of visited location. Measured in meters.", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" - }, - "routes": { - "description": "Information relating to the potential routes of a vehicular UE.", - "items": { - "$ref": "#/components/schemas/PredictedQos.routes" - }, - "minItems": 1, - "required": [ - "routeInfo" - ], - "type": "array", - "x-etsi-mec-cardinality": "1..N", - "x-etsi-mec-origin-type": "Structure (inlined)" - }, - "timeGranularity": { - "$ref": "#/components/schemas/TimeStamp" - } - }, - "required": [ - "locationGranularity", - "routes" - ], - "type": "object", - "x-etsi-notes": "NOTE:\tThe data type of locationGranularity is a string which indicates the granularity of a visited location by means of latitudinal and longitudinal margins.", - "x-etsi-ref": "6.2.5" - }, - "PredictedQos.routes": { - "properties": { - "routeInfo": { - "description": "Information relating to a specific route.\nThe first structure shall relate to the route origin and the last to the route destination. Intermediate waypoint locations may also be provided.", - "items": { - "$ref": "#/components/schemas/PredictedQos.routes.routeInfo" - }, - "required": [ - "location" - ], - "minItems": 2, - "type": "array", - "x-etsi-mec-cardinality": "2..N", - "x-etsi-mec-origin-type": "Structure (inlined)" - } - }, - "type": "object", - "minItems": 1 - }, - "PredictedQos.routes.routeInfo": { - "type": "object", - "properties": { - "location": { - "$ref": "#/components/schemas/LocationInfo" - }, - "rsrp": { - "description": "Reference Signal Received Power as defined in ETSI TS 136 214 [i.13].\nShall only be included in the response.", - "format": "uint8", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint8" - }, - "rsrq": { - "description": "Reference Signal Received Quality as defined in ETSI TS 136 214 [i.13].\nShall only be included in the response.", - "format": "uint8", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint8" - }, - "time": { - "$ref": "#/components/schemas/TimeStamp" - } - } - }, - "ProblemDetails": { - "properties": { - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem", - "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" - }, - "instance": { - "description": "A URI reference that identifies the specific occurrence of the problem", - "format": "uri", - "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "URI" - }, - "status": { - "description": "The HTTP status code for this occurrence of the problem", - "format": "uint32", - "type": "integer", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uint32" - }, - "title": { - "description": "A short, human-readable summary of the problem type", - "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" - }, - "type": { - "description": "A URI reference according to IETF RFC 3986 that identifies the problem type", - "format": "uri", - "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "URI" - } - }, - "type": "object" - }, - "ProvChgPc5Notification": { - "properties": { - "dstLayer2Id": { - "description": "For sidelink communication, the Destination Layer-2 ID is set to the ProSe Layer-2 Group ID or Prose UE ID, see ETSI TS 136 321 [i.12].", - "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "String" - }, - "locationInfo": { - "$ref": "#/components/schemas/LocationInfo" - }, - "neighbourCellInfo": { - "description": "The information of the neighbour cells in a visiting PLMN that support V2X communication over PC5.", - "items": { - "$ref": "#/components/schemas/Pc5NeighbourCellInfo" - }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "Pc5NeighbourCellInfo" - }, - "notificationType": { - "description": "Shall be set to \"ProvChgPc5Notification\".", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" - }, - "timeStamp": { - "$ref": "#/components/schemas/TimeStamp" - } - }, - "required": [ - "notificationType", - "locationInfo" - ], - "type": "object", - "x-etsi-ref": "6.4.4" - }, - "ProvChgPc5Subscription": { - "properties": { - "_links": { - "$ref": "#/components/schemas/links" - }, - "callbackReference": { - "description": "URI exposed by the client on which to receive notifications via HTTP. See note.", - "format": "uri", - "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uri" - }, - "expiryDeadline": { - "$ref": "#/components/schemas/TimeStamp" - }, - "filterCriteria": { - "$ref": "#/components/schemas/ProvChgPc5Subscription.filterCriteria" - }, - "requestTestNotification": { - "description": "Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as described in ETSI GS MEC 009 [i.1], clause 6.12a.\nDefault: FALSE.", - "type": "boolean", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Boolean" - }, - "subscriptionType": { - "description": "Shall be set to \"ProvChgPc5Subscription\".", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" - }, - "websockNotifConfig": { - "$ref": "#/components/schemas/WebsockNotifConfig" - } - }, - "required": [ - "subscriptionType", - "filterCriteria" - ], - "type": "object", - "x-etsi-notes": "NOTE: At least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to VIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009 [i.1], clause 6.12a.", - "x-etsi-ref": "6.3.4" - }, - "ProvChgPc5Subscription.filterCriteria": { - "description": "List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response.", - "properties": { - "dstLayer2Id": { - "description": "For sidelink communication, the Destination Layer-2 ID is set to the ProSe Layer-2 Group ID or Prose UE ID, see ETSI TS 136 321 [i.12].", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" - }, - "locationInfo": { - "$ref": "#/components/schemas/LocationInfo" - }, - "neighbourCellInfo": { - "description": "The information of the neighbour cells in a visiting PLMN that support V2X communication over PC5.", - "items": { - "$ref": "#/components/schemas/Pc5NeighbourCellInfo" - }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "Pc5NeighbourCellInfo" - } - }, - "required": [ - "locationInfo", - "dstLayer2Id" - ], - "type": "object", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Structure (inlined)" - }, - "ProvChgUuMbmsNotification": { - "properties": { - "locationInfo": { - "$ref": "#/components/schemas/LocationInfo" - }, - "neighbourCellInfo": { - "description": "The information of the neighbour cells in a visiting PLMN that support V2X communication over Uu MBMS.", - "items": { - "$ref": "#/components/schemas/UuMbmsNeighbourCellInfo" - }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "UuMbmsNeighbourCellInfo" - }, - "notificationType": { - "description": "Shall be set to \"ProvChgUuMbmsNotification\".", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" - }, - "timeStamp": { - "$ref": "#/components/schemas/TimeStamp" - }, - "v2xServerUsd": { - "$ref": "#/components/schemas/V2xServerUsd" - } - }, - "required": [ - "notificationType", - "locationInfo" - ], - "type": "object", - "x-etsi-ref": "6.4.3" - }, - "ProvChgUuMbmsSubscription": { - "properties": { - "_links": { - "$ref": "#/components/schemas/links" - }, - "callbackReference": { - "description": "URI exposed by the client on which to receive notifications via HTTP. See note.", - "format": "uri", - "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uri" - }, - "expiryDeadline": { - "$ref": "#/components/schemas/TimeStamp" - }, - "filterCriteria": { - "$ref": "#/components/schemas/ProvChgUuMbmsSubscription.filterCriteria" - }, - "requestTestNotification": { - "description": "Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as described in ETSI GS MEC 009 [i.1], clause 6.12a.\nDefault: FALSE.", - "type": "boolean", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Boolean" - }, - "subscriptionType": { - "description": "Shall be set to \"ProvChgUuMbmsSubscription\".", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" - }, - "websockNotifConfig": { - "$ref": "#/components/schemas/WebsockNotifConfig" - } - }, - "required": [ - "subscriptionType", - "filterCriteria" - ], - "type": "object", - "x-etsi-notes": "NOTE:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to VIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009 [i.1], clause 6.12a.", - "x-etsi-ref": "6.3.3" - }, - "ProvChgUuMbmsSubscription.filterCriteria": { - "description": "List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response.", - "properties": { - "locationInfo": { - "$ref": "#/components/schemas/LocationInfo" - }, - "neighbourCellInfo": { - "description": "The information of the neighbour cells in a visiting PLMN that support V2X communication over Uu MBMS.", - "items": { - "$ref": "#/components/schemas/UuMbmsNeighbourCellInfo" - }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "UuMbmsNeighbourCellInfo" - }, - "v2xServerUsd": { - "$ref": "#/components/schemas/V2xServerUsd" - } - }, - "required": [ - "locationInfo", - "v2xServerUsd" - ], - "type": "object", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Structure (inlined)" - }, - "ProvChgUuUniNotification": { - "properties": { - "locationInfo": { - "$ref": "#/components/schemas/LocationInfo" - }, - "neighbourCellInfo": { - "description": "The information of the neighbour cells in a visiting PLMN that support V2X communication over Uu unicast.", - "items": { - "$ref": "#/components/schemas/UuUniNeighbourCellInfo" - }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "UuUniNeighbourCellInfo" - }, - "notificationType": { - "description": "Shall be set to \"ProvChgUuUniNotification\".", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" - }, - "timeStamp": { - "$ref": "#/components/schemas/TimeStamp" - }, - "v2xApplicationServer": { - "$ref": "#/components/schemas/V2xApplicationServer" - } - }, - "required": [ - "notificationType", - "locationInfo" - ], - "type": "object", - "x-etsi-ref": "6.4.2" - }, - "ProvChgUuUniSubscription": { - "properties": { - "_links": { - "$ref": "#/components/schemas/links" - }, - "callbackReference": { - "description": "URI exposed by the client on which to receive notifications via HTTP. See note.", - "format": "uri", - "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uri" - }, - "expiryDeadline": { - "$ref": "#/components/schemas/TimeStamp" - }, - "filterCriteria": { - "$ref": "#/components/schemas/ProvChgUuUniSubscription.filterCriteria" - }, - "requestTestNotification": { - "description": "Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as described in ETSI GS MEC 009 [i.1], clause 6.12a.\nDefault: FALSE.", - "type": "boolean", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Boolean" - }, - "subscriptionType": { - "description": "Shall be set to \"ProvChgUuUniSubscription\".", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" - }, - "websockNotifConfig": { - "$ref": "#/components/schemas/WebsockNotifConfig" - } - }, - "required": [ - "subscriptionType", - "filterCriteria" - ], - "type": "object", - "x-etsi-notes": "NOTE:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to VIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009 [i.1], clause 6.12a.", - "x-etsi-ref": "6.3.2" - }, - "ProvChgUuUniSubscription.filterCriteria": { - "description": "List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response.", - "properties": { - "locationInfo": { - "$ref": "#/components/schemas/LocationInfo" - }, - "neighbourCellInfo": { - "description": "The information of the neighbour cells in a visiting PLMN that support V2X communication over Uu unicast.", - "items": { - "$ref": "#/components/schemas/UuUniNeighbourCellInfo" - }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "UuUniNeighbourCellInfo" - }, - "v2xApplicationServer": { - "$ref": "#/components/schemas/V2xApplicationServer" - } - }, - "required": [ - "locationInfo", - "v2xApplicationServer" - ], - "type": "object", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Structure (inlined)" - }, - "SubscriptionLinkList": { - "properties": { - "_links": { - "$ref": "#/components/schemas/SubscriptionLinkList.links" - } - }, - "required": [ - "_links" - ], - "type": "object", - "x-etsi-ref": "6.3.6" - }, - "SystemInformationBlockType21": { - "type": "object" - }, - "TddInfo": { - "properties": { - "earfcn": { - "$ref": "#/components/schemas/Earfcn" - }, - "subframeAssignment": { - "description": "Uplink-downlink subframe configuration information.", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" - }, - "transmissionBandwidth": { - "$ref": "#/components/schemas/TransmissionBandwidth" - } - }, - "required": [ - "earfcn", - "transmissionBandwidth", - "subframeAssignment" - ], - "type": "object", - "x-etsi-ref": "6.5.7" - }, - "SubscriptionLinkList.links": { - "description": "List of hyperlinks related to the resource.", - "properties": { - "self": { - "$ref": "#/components/schemas/LinkType" - }, - "subscriptions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SubscriptionLinkList.links.subscriptions" - } - } - }, - "required": [ - "self" - ], - "type": "object", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Structure (inlined)" - }, - "SubscriptionLinkList.links.subscriptions": { - "description": "The service consumer's subscriptions.", - "type": "object", - "minItems": 0, - "properties": { - "href": { - "description": "The URI referring to the subscription.", - "format": "uri", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "URI" - }, - "subscriptionType": { - "description": "Type of the subscription. The values are as defined in the \"subscriptionType\" attribute for each different V2X information event subscription data type.", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" - } - }, - "required": [ - "href", - "subscriptionType" - ], - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "Structure (inlined)" - }, - "TestNotification": { - "properties": { - "_links": { - "description": "Hyperlink related to the resource. ", - "properties": { - "subscription": { - "$ref": "#/components/schemas/LinkType" - } - }, - "required": [ - "subscription" - ], - "type": "object", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Structure (inlined)" - }, - "notificationType": { - "description": "Shall be set to \"TestNotification\".", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" - } - }, - "required": [ - "notificationType", - "_links" - ], - "type": "object", - "x-etsi-ref": "6.4.6" - }, - "TimeStamp": { - "properties": { - "nanoSeconds": { - "description": "The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.", - "format": "uint32", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint32" - }, - "seconds": { - "description": "The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.", - "format": "uint32", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Uint32" - } - }, - "required": [ - "seconds", - "nanoSeconds" - ], - "type": "object", - "x-etsi-ref": "6.5.2" - }, - "TransmissionBandwidth": { - "properties": { - "transmissionBandwidth": { - "$ref": "#/components/schemas/TransmissionBandwidth.transmissionBandwidth" - } - }, - "required": [ - "transmissionBandwidth" - ], - "type": "object", - "x-etsi-ref": "6.6.4" - }, - "TransmissionBandwidth.transmissionBandwidth": { - "description": "'Numeric value corresponding to the transmission bandwidth expressed in units of resource blocks as follows:\n\n1 = bw6 (6 resource blocks)\n\n2 = bw15 (15 resource blocks)\n\n3 = bw25 (25 resource blocks)\n\n4 = bw50 (50 resource blocks)\n\n5 = bw75 (75 resource blocks)\n\n6 = bw100 (100 resource blocks)'\n", - "enum": [ - 1, - 2, - 3, - 4, - 5, - 6 - ], - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Enum" - }, - "UuMbmsNeighbourCellInfo": { - "properties": { - "ecgi": { - "$ref": "#/components/schemas/Ecgi" - }, - "fddInfo": { - "$ref": "#/components/schemas/FddInfo" - }, - "mbmsServiceAreaIdentity": { - "description": "Supported MBMS Service Area Identities in the cell.", - "items": { - "type": "string" - }, - "minItems": 1, - "type": "array", - "x-etsi-mec-cardinality": "1..N", - "x-etsi-mec-origin-type": "String" - }, - "pci": { - "description": "Physical Cell Identifier.", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Integer" - }, - "plmn": { - "$ref": "#/components/schemas/Plmn" - }, - "tddInfo": { - "$ref": "#/components/schemas/TddInfo" - } - }, - "required": [ - "plmn", - "ecgi", - "pci", - "fddInfo", - "tddInfo", - "mbmsServiceAreaIdentity" - ], - "type": "object", - "x-etsi-ref": "6.5.11" - }, - "UuMbmsProvisioningInfo": { - "properties": { - "proInfoUuMbms": { - "type": "array", - "minItems": 1, - "items": { - "$ref": "#/components/schemas/UuMbmsProvisioningInfo.proInfoUuMbms" - } - }, - "timeStamp": { - "$ref": "#/components/schemas/TimeStamp" - } - }, - "required": [ - "proInfoUuMbms" - ], - "type": "object", - "x-etsi-ref": "6.2.3" - }, - "UuMbmsProvisioningInfo.proInfoUuMbms": { - "description": "The provisioning information per location as defined below.", - "type": "object", - "properties": { - "locationInfo": { - "$ref": "#/components/schemas/LocationInfo" - }, - "neighbourCellInfo": { - "description": "The information of the neighbour cells in a visiting PLMN that support V2X communication over Uu MBMS.", - "items": { - "$ref": "#/components/schemas/UuMbmsNeighbourCellInfo" - }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "UuMbmsNeighbourCellInfo" - }, - "v2xServerUsd": { - "$ref": "#/components/schemas/V2xServerUsd" - } - }, - "required": [ - "locationInfo", - "v2xServerUsd" - ], - "x-etsi-mec-cardinality": "1..N", - "x-etsi-mec-origin-type": "Structure (inlined)" - }, - "UuUniNeighbourCellInfo": { - "properties": { - "ecgi": { - "$ref": "#/components/schemas/Ecgi" - }, - "fddInfo": { - "$ref": "#/components/schemas/FddInfo" - }, - "pci": { - "description": "Physical Cell Identifier.", - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Integer" - }, - "plmn": { - "$ref": "#/components/schemas/Plmn" - }, - "tddInfo": { - "$ref": "#/components/schemas/TddInfo" - } - }, - "required": [ - "plmn", - "ecgi", - "pci", - "fddInfo", - "tddInfo" - ], - "type": "object", - "x-etsi-ref": "6.5.9" - }, - "UuUnicastProvisioningInfo": { - "properties": { - "proInfoUuUnicast": { - "type": "array", - "minItems": 1, - "items": { - "$ref": "#/components/schemas/UuUnicastProvisioningInfo.proInfoUuUnicast" - } - }, - "timeStamp": { - "$ref": "#/components/schemas/TimeStamp" - } - }, - "required": [ - "proInfoUuUnicast" - ], - "type": "object", - "x-etsi-ref": "6.2.2" - }, - "UuUnicastProvisioningInfo.proInfoUuUnicast": { - "description": "The provisioning information per location as defined below.", - "type": "object", - "properties": { - "locationInfo": { - "$ref": "#/components/schemas/LocationInfo" - }, - "neighbourCellInfo": { - "description": "The information of the neighbour cells in a visiting PLMN that support V2X communication over Uu unicast.", - "items": { - "$ref": "#/components/schemas/UuUniNeighbourCellInfo" - }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "UuUniNeighbourCellInfo" - }, - "v2xApplicationServer": { - "$ref": "#/components/schemas/V2xApplicationServer" - } - }, - "required": [ - "locationInfo", - "v2xApplicationServer" - ], - "x-etsi-mec-cardinality": "1..N", - "x-etsi-mec-origin-type": "Structure (inlined)" - }, - "V2xApplicationServer": { - "properties": { - "ipAddress": { - "description": "", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" - }, - "udpPort": { - "description": "", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" - } - }, - "required": [ - "ipAddress", - "udpPort" - ], - "type": "object", - "x-etsi-ref": "6.5.8" - }, - "V2xMsgNotification": { - "properties": { - "_links": { - "$ref": "#/components/schemas/V2xMsgNotification.links" - }, - "msgContent": { - "description": "Published V2X message content. The format of the string is defined by the standardization organization indicated by the attribute stdOrganization.", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" - }, - "msgEncodeFormat": { - "description": "The encode format of the V2X message, for example base64.", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" - }, - "msgType": { - "$ref": "#/components/schemas/msgType" - }, - "notificationType": { - "description": "Shall be set to \"V2xMsgNotification\".", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" - }, - "stdOrganization": { - "description": "Standardization organization which defines the published V2X message type: \nETSI: European Telecommunications Standards Institute.\nSee note 1.", - "enum": [ - "ETSI" - ], - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Enum" - }, - "timeStamp": { - "$ref": "#/components/schemas/TimeStamp" - } - }, - "required": [ - "notificationType", - "timeStamp", - "stdOrganization", - "msgType", - "msgEncodeFormat", - "msgContent", - "_links" - ], - "type": "object", - "x-etsi-notes": "NOTE 1:\tOther standardization organizations could be added as needed.\nNOTE 2:\tThe V2X message types of ETSI shall be used as specified in ETSI TS 102 894-2 [6], clause A.114.", - "x-etsi-ref": "6.4.5" - }, - "V2xMsgNotification.links": { - "description": "links to resources related to this notification.", - "properties": { - "subscription": { - "$ref": "#/components/schemas/LinkType" - } - }, - "required": [ - "subscription" - ], - "type": "object", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Structure (inlined)" - }, - "V2xMsgPublication": { - "properties": { - "msgContent": { - "description": "Published V2X message content. Its format is defined by the standardization organization indicated by the attribute stdOrganization.", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" - }, - "msgEncodeFormat": { - "description": "The encode format of the V2X message, for example base64.", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" - }, - "msgType": { - "$ref": "#/components/schemas/msgType" - }, - "stdOrganization": { - "description": "Standardization organization which defines the published V2X message type:\nETSI: European Telecommunications Standards Institute. \nSee note 1.", - "enum": [ - "ETSI" - ], - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Enum" - } - }, - "required": [ - "stdOrganization", - "msgType", - "msgEncodeFormat", - "msgContent" - ], - "type": "object", - "x-etsi-notes": "NOTE 1:\tOther standardization organizations could be added as needed.\nNOTE 2:\tThe V2X message types of ETSI shall be used as specified in ETSI TS 102 894-2 [6], clause A.114.", - "x-etsi-ref": "6.2.6" - }, - "msgType": { - "description": "Published V2X message type. Its value is defined by the standardization organization indicated by the attribute stdOrganization. See note 2.\n− denm(1): Decentralized Environmental Notification Message (DENM) as specified in ETSI EN 302 637-3,\n− cam(2): Cooperative Awareness Message (CAM) as specified in ETSI EN 302 637-2,\n− poi(3): Point of Interest message as specified in ETSI TS 101 556-1,\n− spatem(4): Signal Phase And Timing (SPAT) message as specified in SAE J2735 and in ETSI TS 103 301,\n− mapem(5): MAP message as specified in SAE J2735 and in ETSI TS 103 301,\n− ivim(6): In Vehicle Information (IVI) message as defined in ISO TS 19321,\n− ev-rsr(7): Electric vehicle recharging spot reservation message, as defined in ETSI TS 101 556-3,\n− tistpgtransaction(8): messages for Tyre Information System (TIS) and Tyre Pressure Gauge (TPG) interoperability, as specified in ETSI TS 101 556-2,\n− srem(9): Traffic light Signal Request Message as specified in ETSI TS 103 301,\n− ssem(10): Traffic Light Signal Request Status Message as specified in ETSI TS 103 301.\n− evcsn(11): Electrical Vehicle Charging Spot Notification message as specified in ETSI TS 101 556-1,\n− saem(12): Services Announcement Extended Message as specified in ETSI TS 102 890-1,\n− rtcmem(13): Radio Technical Commission for Maritime Services (RTCM) Message as specified in ETSI TS 103 301,\n", - "enum": [ - 1, - 2, - 3, - 4, - 5, - 6, - 7, - 8, - 9, - 10, - 11, - 12, - 13 - ], - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Enum" - }, - "V2xMsgSubscription": { - "properties": { - "_links": { - "$ref": "#/components/schemas/links" - }, - "callbackReference": { - "description": "URI exposed by the client on which to receive notifications via HTTP. See note 1.", - "format": "uri", - "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uri" - }, - "expiryDeadline": { - "$ref": "#/components/schemas/TimeStamp" - }, - "filterCriteria": { - "$ref": "#/components/schemas/V2xMsgSubscription.filterCriteria" - }, - "requestTestNotification": { - "description": "Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as described in ETSI GS MEC 009 [i.1], clause 6.12a.\nDefault: FALSE.", - "type": "boolean", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Boolean" - }, - "subscriptionType": { - "description": "Shall be set to \"V2xMsgSubscription\".", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" - }, - "websockNotifConfig": { - "$ref": "#/components/schemas/WebsockNotifConfig" - } - }, - "required": [ - "subscriptionType", - "filterCriteria" - ], - "type": "object", - "x-etsi-notes": "NOTE 1:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to VIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009 [i.1], clause 6.12a.\nNOTE 2:\tOther standardization organizations could be added as needed.\nNOTE 3:\tThe V2X message types of ETSI shall be used as specified in ETSI TS 102 894-2 [6], clause A.114.", - "x-etsi-ref": "6.3.5" - }, - "V2xMsgSubscription.filterCriteria": { - "description": "List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response.", - "properties": { - "msgType": { - "description": "Subscribed V2X message type. Its value is defined by the standardization organization indicated by the attribute stdOrganization. See note 3.", - "items": { - "type": "string" - }, - "minItems": 0, - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "Enum" - }, - "stdOrganization": { - "description": "Standardization organization which defines the subscribed V2X message type: \nETSI: European Telecommunications Standards Institute. \nSee note 2.", - "enum": [ - "ETSI" - ], - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Enum" - } - }, - "required": [ - "stdOrganization" - ], - "type": "object", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Structure (inlined)" - }, - "V2xServerUsd": { - "properties": { - "sdpInfo": { - "$ref": "#/components/schemas/V2xServerUsd.sdpInfo" - }, - "serviceAreaIdentifier": { - "description": "A list of service area identifier for the applicable MBMS broadcast area.", - "items": { - "type": "string" - }, - "minItems": 1, - "type": "array", - "x-etsi-mec-cardinality": "1..N", - "x-etsi-mec-origin-type": "String" - }, - "tmgi": { - "$ref": "#/components/schemas/V2xServerUsd.tmgi" - } - }, - "required": [ - "tmgi", - "serviceAreaIdentifier", - "sdpInfo" - ], - "type": "object", - "x-etsi-ref": "6.5.10" - }, - "V2xServerUsd.sdpInfo": { - "description": "SDP with IP multicast address and port number used for V2X communication via MBMS.", - "properties": { - "ipMulticastAddress": { - "description": "", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" - }, - "portNumber": { - "description": "", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" - } - }, - "required": [ - "ipMulticastAddress", - "portNumber" - ], - "type": "object", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Structure (inlined)" - }, - "V2xServerUsd.tmgi": { - "description": "Temporary Mobile Group Identity (TMGI), which is used within MBMS to uniquely identify Multicast and Broadcast bearer services.", - "properties": { - "mbmsServiceId": { - "description": "MBMS Service ID consisting of three octets.", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" - }, - "mcc": { - "description": "The Mobile Country Code part of PLMN Identity.", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" - }, - "mnc": { - "description": "The Mobile Network Code part of PLMN Identity.", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" - } - }, - "required": [ - "mbmsServiceId", - "mcc", - "mnc" - ], - "type": "object", - "x-etsi-mec-cardinality": "", - "x-etsi-mec-origin-type": "Structure (inlined)" - }, - "WebsockNotifConfig": { - "properties": { - "requestWebsocketUri": { - "description": "Set to TRUE by the service consumer to indicate that Websocket delivery is requested.", - "type": "boolean", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Boolean" - }, - "websocketUri": { - "description": "Set by VIS to indicate to the service consumer the Websocket URI to be used for delivering notifications.", - "format": "uri", - "type": "string", - "x-etsi-mec-cardinality": "0..1", - "x-etsi-mec-origin-type": "Uri" - } - }, - "type": "object", - "x-etsi-ref": "6.5.14" - } - }, - "responses": { - "204": { - "description": "No Content" - }, - "206": { - "description": "Partial content" - }, - "400": { - "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "401": { - "description": "Unauthorized : used when the client did not submit credentials.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "403": { - "description": "Forbidden : operation is not allowed given the current status of the resource.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "406": { - "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "409": { - "description": "Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "412": { - "description": "Precondition failed : used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "415": { - "description": "Unsupported Media Type : used to indicate that the server or the client does not support the content type of the entity body.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "422": { - "description": "Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - }, - "429": { - "description": "Too Many Requests : used when a rate limiter has triggered.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ProblemDetails" - } - } - } - } - } - } -} \ No newline at end of file diff --git a/MEC030_V2XInformationServices.json b/MEC030_V2XInformationServices.json new file mode 100644 index 0000000000000000000000000000000000000000..5f2322323b42c230e418621da1bc0f89bc57ed01 --- /dev/null +++ b/MEC030_V2XInformationServices.json @@ -0,0 +1,2359 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "ETSI GS MEC 030 V2X Information Services API", + "version": "3.1.1", + "description": "ETSI GS MEC 030 V2X Information Services API described using OpenAPI.", + "contact": { + "name": "ETSI Forge", + "email": "cti_support@etsi.org", + "url": "https://forge.etsi.org/rep/mec/gs030-vis-api" + }, + "license": { + "name": "BSD-3-Clause", + "url": "https://forge.etsi.org/legal-matters" + } + }, + "externalDocs": { + "description": "ETSI GS MEC 030 V2X Information Services API, v3.1.1", + "url": "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/030/03.01.01_60/gs_mec030v030101p.pdf" + }, + "servers": [ + { + "url": "https://localhost/vis/v2" + } + ], + "tags": [ + { + "name": "queries", + "description": "Queries" + }, + { + "name": "subscription", + "description": "Subscription" + }, + { + "name": "QoS" + }, + { + "name": "V2X_msg" + } + ], + "paths": { + "/queries/uu_unicast_provisioning_info": { + "get": { + "tags": ["queries"], + "summary": "Used to query provisioning information for V2X communication over Uu unicast.", + "description": "Used to query provisioning information for V2X communication over Uu unicast.", + "operationId": "prov_info_uu_unicastGET", + "parameters": [ + { + "in": "query", + "name": "location_info", + "schema": { + "type": "string" + }, + "required": true, + "description": "Comma separated list of locations to identify a cell of a base station or a particular geographical area" + } + ], + "responses": { + "200": { + "description": "A response body containing the Uu unicast provisioning information. ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UuUnicastProvisioningInfo" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "406": { + "$ref": "#/components/responses/406" + }, + "429": { + "$ref": "#/components/responses/429" + } + } + } + }, + "/queries/uu_mbms_provisioning_info": { + "get": { + "tags": ["queries"], + "summary": "retrieve information required for V2X communication over Uu MBMS.", + "description": "retrieve information required for V2X communication over Uu MBMS.", + "operationId": "prov_info_uu_mbmsGET", + "parameters": [ + { + "in": "query", + "name": "location_info", + "schema": { + "type": "string" + }, + "required": true, + "description": "omma separated list of locations to identify a cell of a base station or a particular geographical area" + } + ], + "responses": { + "200": { + "description": "A response body containing the Uu unicast provisioning information. ", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UuMbmsProvisioningInfo" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "406": { + "$ref": "#/components/responses/406" + }, + "429": { + "$ref": "#/components/responses/429" + } + } + } + }, + "/queries/pc5_provisioning_info": { + "get": { + "tags": ["queries"], + "summary": "Query provisioning information for V2X communication over PC5.", + "description": "Query provisioning information for V2X communication over PC5.", + "operationId": "prov_infoGET", + "parameters": [ + { + "in": "query", + "name": "location_info", + "schema": { + "type": "string" + }, + "required": true, + "description": "Comma separated list of locations to identify a cell of a base station or a particular geographical area" + } + ], + "responses": { + "200": { + "description": "A response body containing the PC5 provisioning information is returned.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Pc5ProvisioningInfo" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "406": { + "$ref": "#/components/responses/406" + }, + "429": { + "$ref": "#/components/responses/429" + } + } + } + }, + "/provide_v2x_msg_distribution_server_info": { + "post": { + "tags": ["V2X_msg"], + "summary": "Request the information about available V2X Message Distribution Servers that can be supported by the service consumer.", + "description": "Request the information about available V2X Message Distribution Servers that can be supported by the service consumer (e.g. a MEC application).", + "operationId": "v2xMsg_distributionServerPost", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V2xMsgDistributionServerInfo" + } + } + } + }, + "responses": { + "200": { + "description": "The response body shall contain the connection information of the V2X Message Distribution Servers that the service consumer can use for direct connection.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V2xMsgDistributionServerInfo" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + } + } + } + }, + "/provide_predicted_qos": { + "post": { + "tags": ["QoS"], + "summary": "Request the predicted QoS correspondent to potential routes of a vehicular UE.", + "description": "Request the predicted QoS correspondent to potential routes of a vehicular UE.", + "operationId": "predicted_qosPOST", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PredictedQos" + } + } + } + }, + "responses": { + "200": { + "description": "The response body shall contain the predicted QoS corresponding to potential routes of a vehicular UE", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PredictedQos" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + } + } + } + }, + "/publish_v2x_message": { + "post": { + "tags": ["V2X_msg"], + "summary": "Used to publish a V2X message.", + "description": "Used to publish a V2X message.", + "operationId": "v2x_messagePOST", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/V2xMsgPublication" + } + } + } + }, + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "406": { + "$ref": "#/components/responses/406" + }, + "429": { + "$ref": "#/components/responses/429" + } + } + } + }, + "/subscriptions": { + "get": { + "tags": ["subscription"], + "summary": "Request information about the subscriptions for this requestor.", + "description": "Request information about the subscriptions for this requestor.", + "operationId": "subGET", + "parameters": [ + { + "in": "query", + "name": "subscription_type", + "description": "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. pred_qos: information on the predicted QoS", + "schema": { + "type": "string" + }, + "required": false + } + ], + "responses": { + "200": { + "description": "A response body containing the list of links to requestor subscriptions is returned.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SubscriptionLinkList" + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "406": { + "$ref": "#/components/responses/406" + }, + "429": { + "$ref": "#/components/responses/429" + } + } + }, + "post": { + "tags": ["subscription"], + "summary": " create a new subscription to VIS notifications.", + "description": " create a new subscription to VIS notifications.", + "operationId": "subPOST", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/ProvChgUuUniSubscription" + }, + { + "$ref": "#/components/schemas/ProvChgUuMbmsSubscription" + }, + { + "$ref": "#/components/schemas/ProvChgPc5Subscription" + }, + { + "$ref": "#/components/schemas/V2xMsgSubscription" + } + ] + } + } + } + }, + "responses": { + "201": { + "description": "In the returned NotificationSubscription structure, the created subscription is described using the appropriate data type.", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/ProvChgUuUniSubscription" + }, + { + "$ref": "#/components/schemas/ProvChgUuMbmsSubscription" + }, + { + "$ref": "#/components/schemas/ProvChgPc5Subscription" + }, + { + "$ref": "#/components/schemas/V2xMsgSubscription" + } + ] + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "406": { + "$ref": "#/components/responses/406" + }, + "415": { + "$ref": "#/components/responses/415" + }, + "422": { + "$ref": "#/components/responses/422" + }, + "429": { + "$ref": "#/components/responses/429" + } + }, + "callbacks": { + "notification": { + "{$request.body#/callbackReference}": { + "post": { + "summary": "Callback POST used to send a notification", + "description": "A notification from VIS.", + "operationId": "notificationPOST", + "requestBody": { + "description": "Subscription notification", + "required": true, + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/ProvChgUuUniNotification" + }, + { + "$ref": "#/components/schemas/ProvChgUuMbmsNotification" + }, + { + "$ref": "#/components/schemas/ProvChgPc5Notification" + }, + { + "$ref": "#/components/schemas/V2xMsgNotification" + } + ] + } + } + } + }, + "responses": { + "204": { + "$ref": "#/components/responses/204" + } + } + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}": { + "parameters": [ + { + "in": "path", + "name": "subscriptionId", + "description": "Refers to created subscription, where the VIS API allocates a unique resource name for this subscription", + "schema": { + "type": "string" + }, + "required": true + } + ], + "get": { + "tags": ["subscription"], + "summary": "Retrieve information about this subscription.", + "description": "Retrieve information about this subscription.", + "operationId": "individualSubscriptionGET", + "responses": { + "200": { + "description": "A response body containing the data type describing the specific RNI event subscription is returned", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/ProvChgUuUniSubscription" + }, + { + "$ref": "#/components/schemas/ProvChgUuMbmsSubscription" + }, + { + "$ref": "#/components/schemas/ProvChgPc5Subscription" + }, + { + "$ref": "#/components/schemas/V2xMsgSubscription" + }, + { + "$ref": "#/components/schemas/PredQosSubscription" + } + ] + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "406": { + "$ref": "#/components/responses/406" + }, + "429": { + "$ref": "#/components/responses/429" + } + } + }, + "put": { + "tags": ["subscription"], + "summary": "Used to update the existing subscription.", + "description": "Used to update the existing subscription.", + "operationId": "individualSubscriptionPUT", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/ProvChgUuUniSubscription" + }, + { + "$ref": "#/components/schemas/ProvChgUuMbmsSubscription" + }, + { + "$ref": "#/components/schemas/ProvChgPc5Subscription" + }, + { + "$ref": "#/components/schemas/V2xMsgSubscription" + }, + { + "$ref": "#/components/schemas/PredQosSubscription" + } + ] + } + } + } + }, + "responses": { + "200": { + "description": "A response body containing data type describing the updated subscription is returned", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/ProvChgUuUniSubscription" + }, + { + "$ref": "#/components/schemas/ProvChgUuMbmsSubscription" + }, + { + "$ref": "#/components/schemas/ProvChgPc5Subscription" + }, + { + "$ref": "#/components/schemas/V2xMsgSubscription" + }, + { + "$ref": "#/components/schemas/PredQosSubscription" + } + ] + } + } + } + }, + "400": { + "$ref": "#/components/responses/400" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "406": { + "$ref": "#/components/responses/406" + }, + "412": { + "$ref": "#/components/responses/412" + }, + "422": { + "$ref": "#/components/responses/422" + }, + "429": { + "$ref": "#/components/responses/429" + } + } + }, + "delete": { + "tags": ["subscription"], + "summary": "Used to cancel the existing subscription.", + "description": "Used to cancel the existing subscription.", + "operationId": "individualSubscriptionDELETE", + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "401": { + "$ref": "#/components/responses/401" + }, + "403": { + "$ref": "#/components/responses/403" + }, + "404": { + "$ref": "#/components/responses/404" + }, + "429": { + "$ref": "#/components/responses/429" + } + } + } + } + }, + "components": { + "schemas": { + "CellId": { + "properties": { + "cellId": { + "description": "E-UTRAN Cell Identity as a bit string (size (28)).", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + } + }, + "required": ["cellId"], + "type": "object", + "x-etsi-ref": "6.6.2" + }, + "Earfcn": { + "properties": { + "earfcn": { + "description": "E-UTRA Absolute Radio Frequency Channel Number, range (0... 65535)", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Integer" + } + }, + "required": ["earfcn"], + "type": "object", + "x-etsi-ref": "6.6.3" + }, + "Ecgi": { + "properties": { + "cellId": { + "$ref": "#/components/schemas/CellId" + }, + "plmn": { + "$ref": "#/components/schemas/Plmn" + } + }, + "required": ["plmn", "cellId"], + "type": "object", + "x-etsi-ref": "6.5.5" + }, + "FddInfo": { + "properties": { + "dlEarfcn": { + "$ref": "#/components/schemas/Earfcn" + }, + "dlTransmissionBandwidth": { + "$ref": "#/components/schemas/TransmissionBandwidth" + }, + "ulEarfcn": { + "$ref": "#/components/schemas/Earfcn" + }, + "ulTransmissionBandwidth": { + "$ref": "#/components/schemas/TransmissionBandwidth" + } + }, + "required": [ + "ulEarfcn", + "dlEarfcn", + "ulTransmissionBandwidth", + "dlTransmissionBandwidth" + ], + "type": "object", + "x-etsi-ref": "6.5.6" + }, + "links": { + "description": "Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.", + "properties": { + "self": { + "$ref": "#/components/schemas/LinkType" + } + }, + "required": ["self"], + "type": "object", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Structure (inlined)" + }, + "LinkType": { + "properties": { + "href": { + "description": "URI referring to a resource", + "format": "uri", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uri" + } + }, + "required": ["href"], + "type": "object", + "x-etsi-ref": "6.5.13" + }, + "LocationInfo": { + "properties": { + "ecgi": { + "$ref": "#/components/schemas/Ecgi" + }, + "geoArea": { + "$ref": "#/components/schemas/LocationInfo.geoArea" + } + }, + "type": "object", + "x-etsi-notes": "NOTE:\tEither ecgi or geoArea shall be present, but not both.", + "x-etsi-ref": "6.5.3" + }, + "LocationInfo.geoArea": { + "description": "Information of a geographical area.", + "properties": { + "latitude": { + "description": "Latitude (DATUM = WGS84) -90 to 90 in decimal degree format DDD.ddd", + "format": "float", + "type": "number", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Float" + }, + "longitude": { + "description": "Longitude (DATUM = WGS84) -180 to 180 in decimal degree format DDD.ddd", + "format": "float", + "type": "number", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Float" + } + }, + "required": ["latitude", "longitude"], + "type": "object", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Structure (inlined)" + }, + "Pc5NeighbourCellInfo": { + "properties": { + "ecgi": { + "$ref": "#/components/schemas/Ecgi" + }, + "plmn": { + "$ref": "#/components/schemas/Plmn" + }, + "siV2xConfig": { + "$ref": "#/components/schemas/SystemInformationBlockType21" + } + }, + "required": ["plmn", "ecgi", "siV2xConfig"], + "type": "object", + "x-etsi-ref": "6.5.12" + }, + "Pc5ProvisioningInfo": { + "properties": { + "proInfoPc5": { + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/components/schemas/Pc5ProvisioningInfo.proInfoPc5" + } + }, + "timeStamp": { + "$ref": "#/components/schemas/TimeStamp" + } + }, + "required": ["proInfoPc5"], + "type": "object", + "x-etsi-ref": "6.2.4" + }, + "Pc5ProvisioningInfo.proInfoPc5": { + "description": "The provisioning information per location as defined below.", + "type": "object", + "properties": { + "dstLayer2Id": { + "description": "For sidelink communication, the Destination Layer-2 ID is set to the ProSe Layer-2 Group ID or Prose UE ID, see ETSI TS 136 321 [i.12].\nPLMN operators coordinate to make sure Destination Layer2 ID(s) for different V2X services are configured in a consistent manner.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "locationInfo": { + "$ref": "#/components/schemas/LocationInfo" + }, + "neighbourCellInfo": { + "description": "The information of the neighbour cells in a visiting PLMN that support V2X communication over PC5.", + "items": { + "$ref": "#/components/schemas/Pc5NeighbourCellInfo" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "Pc5NeighbourCellInfo" + } + }, + "required": ["locationInfo", "dstLayer2Id"], + "x-etsi-mec-cardinality": "1..N", + "x-etsi-mec-origin-type": "Structure (inlined)" + }, + "Plmn": { + "properties": { + "mcc": { + "description": "The Mobile Country Code part of PLMN Identity.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "mnc": { + "description": "The Mobile Network Code part of PLMN Identity.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + } + }, + "required": ["mcc", "mnc"], + "type": "object", + "x-etsi-ref": "6.5.4" + }, + "PredictedQos": { + "properties": { + "locationGranularity": { + "description": "Granularity of visited location. Measured in meters.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "noticePeriod": { + "$ref": "#/components/schemas/TimeStamp" + }, + "predictionArea": { + "$ref": "#/components/schemas/PredictionArea" + }, + "predictionTarget": { + "description": "Indicates target of QoS prediction. Valid values:\n\n1.\tSINGLE_UE_PREDICTION: \nThe predicted QoS is to be intended as journey-specific for a requesting vehicular UE.\n\n2.\tE2E_APPLICATION_INSTANCE_PREDICTION:\nThe E2E user plane link between two V2X application instances, where one instance relates to a single vehicular UE and the other instance to an application instance within another network, i.e. either another vehicular UE as in the V2N2V case, or an infrastructure element as in the V2N2I case.\n\nShall only be included in the request.\n\n", + "enum": ["SEE_DESCRIPTION"], + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Enum_inlined" + }, + "qos": { + "$ref": "#/components/schemas/Qos" + }, + "routes": { + "items": { + "$ref": "#/components/schemas/Routes" + }, + "type": "array" + }, + "timeGranularity": { + "$ref": "#/components/schemas/TimeStamp" + } + }, + "required": ["predictionTarget", "locationGranularity", "qos"], + "type": "object", + "x-etsi-notes": "NOTE:\tThe data type of locationGranularity is a string which indicates the granularity of a visited location by means of latitudinal and longitudinal margins.", + "x-etsi-ref": "6.2.6" + }, + "PredictedQos.routes": { + "properties": { + "routeInfo": { + "description": "Information relating to a specific route.\nThe first structure shall relate to the route origin and the last to the route destination. Intermediate waypoint locations may also be provided.", + "items": { + "$ref": "#/components/schemas/PredictedQos.routes.routeInfo" + }, + "required": ["location"], + "minItems": 2, + "type": "array", + "x-etsi-mec-cardinality": "2..N", + "x-etsi-mec-origin-type": "Structure (inlined)" + } + }, + "type": "object", + "minItems": 1 + }, + "PredictedQos.routes.routeInfo": { + "type": "object", + "properties": { + "location": { + "$ref": "#/components/schemas/LocationInfo" + }, + "rsrp": { + "description": "Reference Signal Received Power as defined in ETSI TS 136 214 [i.13].\nShall only be included in the response.", + "format": "uint8", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint8" + }, + "rsrq": { + "description": "Reference Signal Received Quality as defined in ETSI TS 136 214 [i.13].\nShall only be included in the response.", + "format": "uint8", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint8" + }, + "time": { + "$ref": "#/components/schemas/TimeStamp" + } + } + }, + "ProblemDetails": { + "properties": { + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "instance": { + "description": "A URI reference that identifies the specific occurrence of the problem", + "format": "uri", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "URI" + }, + "status": { + "description": "The HTTP status code for this occurrence of the problem", + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "title": { + "description": "A short, human-readable summary of the problem type", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "type": { + "description": "A URI reference according to IETF RFC 3986 that identifies the problem type", + "format": "uri", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "URI" + } + }, + "type": "object" + }, + "ProvChgPc5Notification": { + "properties": { + "dstLayer2Id": { + "description": "For sidelink communication, the Destination Layer-2 ID is set to the ProSe Layer-2 Group ID or Prose UE ID, see ETSI TS 136 321 [i.12].", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "locationInfo": { + "$ref": "#/components/schemas/LocationInfo" + }, + "neighbourCellInfo": { + "description": "The information of the neighbour cells in a visiting PLMN that support V2X communication over PC5.", + "items": { + "$ref": "#/components/schemas/Pc5NeighbourCellInfo" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "Pc5NeighbourCellInfo" + }, + "notificationType": { + "description": "Shall be set to \"ProvChgPc5Notification\".", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "timeStamp": { + "$ref": "#/components/schemas/TimeStamp" + } + }, + "required": ["notificationType", "locationInfo"], + "type": "object", + "x-etsi-ref": "6.4.4" + }, + "ProvChgPc5Subscription": { + "properties": { + "_links": { + "$ref": "#/components/schemas/links" + }, + "callbackReference": { + "description": "URI exposed by the client on which to receive notifications via HTTP. See note.", + "format": "uri", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uri" + }, + "expiryDeadline": { + "$ref": "#/components/schemas/TimeStamp" + }, + "filterCriteria": { + "$ref": "#/components/schemas/ProvChgPc5Subscription.filterCriteria" + }, + "requestTestNotification": { + "description": "Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as described in ETSI GS MEC 009 [i.1], clause 6.12a.\nDefault: FALSE.", + "type": "boolean", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Boolean" + }, + "subscriptionType": { + "description": "Shall be set to \"ProvChgPc5Subscription\".", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "websockNotifConfig": { + "$ref": "#/components/schemas/WebsockNotifConfig" + } + }, + "required": ["subscriptionType", "filterCriteria"], + "type": "object", + "anyOf": [ + { + "oneOf": [ + { + "required": ["callbackReference"] + }, + { + "required": ["websockNotifConfig"] + } + ] + } + ], + "x-etsi-notes": "NOTE: At least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to VIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009 [i.1], clause 6.12a.", + "x-etsi-ref": "6.3.4" + }, + "ProvChgPc5Subscription.filterCriteria": { + "description": "List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response.", + "properties": { + "dstLayer2Id": { + "description": "For sidelink communication, the Destination Layer-2 ID is set to the ProSe Layer-2 Group ID or Prose UE ID, see ETSI TS 136 321 [i.12].", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "locationInfo": { + "$ref": "#/components/schemas/LocationInfo" + }, + "neighbourCellInfo": { + "description": "The information of the neighbour cells in a visiting PLMN that support V2X communication over PC5.", + "items": { + "$ref": "#/components/schemas/Pc5NeighbourCellInfo" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "Pc5NeighbourCellInfo" + } + }, + "required": ["locationInfo", "dstLayer2Id"], + "type": "object", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Structure (inlined)" + }, + "ProvChgUuMbmsNotification": { + "properties": { + "locationInfo": { + "$ref": "#/components/schemas/LocationInfo" + }, + "neighbourCellInfo": { + "description": "The information of the neighbour cells in a visiting PLMN that support V2X communication over Uu MBMS.", + "items": { + "$ref": "#/components/schemas/UuMbmsNeighbourCellInfo" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "UuMbmsNeighbourCellInfo" + }, + "notificationType": { + "description": "Shall be set to \"ProvChgUuMbmsNotification\".", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "timeStamp": { + "$ref": "#/components/schemas/TimeStamp" + }, + "v2xServerUsd": { + "$ref": "#/components/schemas/V2xServerUsd" + } + }, + "required": ["notificationType", "locationInfo"], + "type": "object", + "x-etsi-ref": "6.4.3" + }, + "ProvChgUuMbmsSubscription": { + "properties": { + "_links": { + "$ref": "#/components/schemas/links" + }, + "callbackReference": { + "description": "URI exposed by the client on which to receive notifications via HTTP. See note.", + "format": "uri", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uri" + }, + "expiryDeadline": { + "$ref": "#/components/schemas/TimeStamp" + }, + "filterCriteria": { + "$ref": "#/components/schemas/ProvChgUuMbmsSubscription.filterCriteria" + }, + "requestTestNotification": { + "description": "Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as described in ETSI GS MEC 009 [i.1], clause 6.12a.\nDefault: FALSE.", + "type": "boolean", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Boolean" + }, + "subscriptionType": { + "description": "Shall be set to \"ProvChgUuMbmsSubscription\".", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "websockNotifConfig": { + "$ref": "#/components/schemas/WebsockNotifConfig" + } + }, + "required": ["subscriptionType", "filterCriteria"], + "type": "object", + "anyOf": [ + { + "oneOf": [ + { + "required": ["callbackReference"] + }, + { + "required": ["websockNotifConfig"] + } + ] + } + ], + "x-etsi-notes": "NOTE:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to VIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009 [i.1], clause 6.12a.", + "x-etsi-ref": "6.3.3" + }, + "ProvChgUuMbmsSubscription.filterCriteria": { + "description": "List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response.", + "properties": { + "locationInfo": { + "$ref": "#/components/schemas/LocationInfo" + }, + "neighbourCellInfo": { + "description": "The information of the neighbour cells in a visiting PLMN that support V2X communication over Uu MBMS.", + "items": { + "$ref": "#/components/schemas/UuMbmsNeighbourCellInfo" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "UuMbmsNeighbourCellInfo" + }, + "v2xServerUsd": { + "$ref": "#/components/schemas/V2xServerUsd" + } + }, + "required": ["locationInfo", "v2xServerUsd"], + "type": "object", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Structure (inlined)" + }, + "ProvChgUuUniNotification": { + "properties": { + "locationInfo": { + "$ref": "#/components/schemas/LocationInfo" + }, + "neighbourCellInfo": { + "description": "The information of the neighbour cells in a visiting PLMN that support V2X communication over Uu unicast.", + "items": { + "$ref": "#/components/schemas/UuUniNeighbourCellInfo" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "UuUniNeighbourCellInfo" + }, + "notificationType": { + "description": "Shall be set to \"ProvChgUuUniNotification\".", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "timeStamp": { + "$ref": "#/components/schemas/TimeStamp" + }, + "v2xApplicationServer": { + "$ref": "#/components/schemas/V2xApplicationServer" + } + }, + "required": ["notificationType", "locationInfo"], + "type": "object", + "x-etsi-ref": "6.4.2" + }, + "ProvChgUuUniSubscription": { + "properties": { + "_links": { + "$ref": "#/components/schemas/links" + }, + "callbackReference": { + "description": "URI exposed by the client on which to receive notifications via HTTP. See note.", + "format": "uri", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uri" + }, + "expiryDeadline": { + "$ref": "#/components/schemas/TimeStamp" + }, + "filterCriteria": { + "$ref": "#/components/schemas/ProvChgUuUniSubscription.filterCriteria" + }, + "requestTestNotification": { + "description": "Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as described in ETSI GS MEC 009 [i.1], clause 6.12a.\nDefault: FALSE.", + "type": "boolean", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Boolean" + }, + "subscriptionType": { + "description": "Shall be set to \"ProvChgUuUniSubscription\".", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "websockNotifConfig": { + "$ref": "#/components/schemas/WebsockNotifConfig" + } + }, + "required": ["subscriptionType", "filterCriteria"], + "type": "object", + "anyOf": [ + { + "oneOf": [ + { + "required": ["callbackReference"] + }, + { + "required": ["websockNotifConfig"] + } + ] + } + ], + "x-etsi-notes": "NOTE:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to VIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009 [i.1], clause 6.12a.", + "x-etsi-ref": "6.3.2" + }, + "ProvChgUuUniSubscription.filterCriteria": { + "description": "List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response.", + "properties": { + "locationInfo": { + "$ref": "#/components/schemas/LocationInfo" + }, + "neighbourCellInfo": { + "description": "The information of the neighbour cells in a visiting PLMN that support V2X communication over Uu unicast.", + "items": { + "$ref": "#/components/schemas/UuUniNeighbourCellInfo" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "UuUniNeighbourCellInfo" + }, + "v2xApplicationServer": { + "$ref": "#/components/schemas/V2xApplicationServer" + } + }, + "required": ["locationInfo", "v2xApplicationServer"], + "type": "object", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Structure (inlined)" + }, + "SubscriptionLinkList": { + "properties": { + "_links": { + "$ref": "#/components/schemas/_links2" + } + }, + "required": ["_links"], + "type": "object", + "x-etsi-ref": "6.3.7" + }, + "SystemInformationBlockType21": { + "type": "object" + }, + "TddInfo": { + "properties": { + "earfcn": { + "$ref": "#/components/schemas/Earfcn" + }, + "subframeAssignment": { + "description": "Uplink-downlink subframe configuration information.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "transmissionBandwidth": { + "$ref": "#/components/schemas/TransmissionBandwidth" + } + }, + "required": ["earfcn", "transmissionBandwidth", "subframeAssignment"], + "type": "object", + "x-etsi-ref": "6.5.7" + }, + "TestNotification": { + "properties": { + "_links": { + "description": "Hyperlink related to the resource. ", + "properties": { + "subscription": { + "$ref": "#/components/schemas/LinkType" + } + }, + "required": ["subscription"], + "type": "object", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Structure (inlined)" + }, + "notificationType": { + "description": "Shall be set to \"TestNotification\".", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + } + }, + "required": ["notificationType", "_links"], + "type": "object", + "x-etsi-ref": "6.4.6" + }, + "TimeStamp": { + "properties": { + "nanoSeconds": { + "description": "The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.", + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + }, + "seconds": { + "description": "The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.", + "format": "uint32", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uint32" + } + }, + "required": ["seconds", "nanoSeconds"], + "type": "object", + "x-etsi-ref": "6.5.2" + }, + "TransmissionBandwidth": { + "properties": { + "transmissionBandwidth": { + "$ref": "#/components/schemas/TransmissionBandwidth.transmissionBandwidth" + } + }, + "required": ["transmissionBandwidth"], + "type": "object", + "x-etsi-ref": "6.6.4" + }, + "TransmissionBandwidth.transmissionBandwidth": { + "description": "'Numeric value corresponding to the transmission bandwidth expressed in units of resource blocks as follows:\n\n1 = bw6 (6 resource blocks)\n\n2 = bw15 (15 resource blocks)\n\n3 = bw25 (25 resource blocks)\n\n4 = bw50 (50 resource blocks)\n\n5 = bw75 (75 resource blocks)\n\n6 = bw100 (100 resource blocks)'\n", + "enum": [1, 2, 3, 4, 5, 6], + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Enum" + }, + "UuMbmsNeighbourCellInfo": { + "properties": { + "ecgi": { + "$ref": "#/components/schemas/Ecgi" + }, + "fddInfo": { + "$ref": "#/components/schemas/FddInfo" + }, + "mbmsServiceAreaIdentity": { + "description": "Supported MBMS Service Area Identities in the cell.", + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array", + "x-etsi-mec-cardinality": "1..N", + "x-etsi-mec-origin-type": "String" + }, + "pci": { + "description": "Physical Cell Identifier.", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Integer" + }, + "plmn": { + "$ref": "#/components/schemas/Plmn" + }, + "tddInfo": { + "$ref": "#/components/schemas/TddInfo" + } + }, + "required": [ + "plmn", + "ecgi", + "pci", + "fddInfo", + "tddInfo", + "mbmsServiceAreaIdentity" + ], + "type": "object", + "x-etsi-ref": "6.5.11" + }, + "UuMbmsProvisioningInfo": { + "properties": { + "proInfoUuMbms": { + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/components/schemas/UuMbmsProvisioningInfo.proInfoUuMbms" + } + }, + "timeStamp": { + "$ref": "#/components/schemas/TimeStamp" + } + }, + "required": ["proInfoUuMbms"], + "type": "object", + "x-etsi-ref": "6.2.3" + }, + "UuMbmsProvisioningInfo.proInfoUuMbms": { + "description": "The provisioning information per location as defined below.", + "type": "object", + "properties": { + "locationInfo": { + "$ref": "#/components/schemas/LocationInfo" + }, + "neighbourCellInfo": { + "description": "The information of the neighbour cells in a visiting PLMN that support V2X communication over Uu MBMS.", + "items": { + "$ref": "#/components/schemas/UuMbmsNeighbourCellInfo" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "UuMbmsNeighbourCellInfo" + }, + "v2xServerUsd": { + "$ref": "#/components/schemas/V2xServerUsd" + } + }, + "required": ["locationInfo", "v2xServerUsd"], + "x-etsi-mec-cardinality": "1..N", + "x-etsi-mec-origin-type": "Structure (inlined)" + }, + "UuUniNeighbourCellInfo": { + "properties": { + "ecgi": { + "$ref": "#/components/schemas/Ecgi" + }, + "fddInfo": { + "$ref": "#/components/schemas/FddInfo" + }, + "pci": { + "description": "Physical Cell Identifier.", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Integer" + }, + "plmn": { + "$ref": "#/components/schemas/Plmn" + }, + "tddInfo": { + "$ref": "#/components/schemas/TddInfo" + } + }, + "required": ["plmn", "ecgi", "pci", "fddInfo", "tddInfo"], + "type": "object", + "x-etsi-ref": "6.5.9" + }, + "UuUnicastProvisioningInfo": { + "properties": { + "proInfoUuUnicast": { + "type": "array", + "minItems": 1, + "items": { + "$ref": "#/components/schemas/UuUnicastProvisioningInfo.proInfoUuUnicast" + } + }, + "timeStamp": { + "$ref": "#/components/schemas/TimeStamp" + } + }, + "required": ["proInfoUuUnicast"], + "type": "object", + "x-etsi-ref": "6.2.2" + }, + "UuUnicastProvisioningInfo.proInfoUuUnicast": { + "description": "The provisioning information per location as defined below.", + "type": "object", + "properties": { + "locationInfo": { + "$ref": "#/components/schemas/LocationInfo" + }, + "neighbourCellInfo": { + "description": "The information of the neighbour cells in a visiting PLMN that support V2X communication over Uu unicast.", + "items": { + "$ref": "#/components/schemas/UuUniNeighbourCellInfo" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "UuUniNeighbourCellInfo" + }, + "v2xApplicationServer": { + "$ref": "#/components/schemas/V2xApplicationServer" + } + }, + "required": ["locationInfo", "v2xApplicationServer"], + "x-etsi-mec-cardinality": "1..N", + "x-etsi-mec-origin-type": "Structure (inlined)" + }, + "V2xApplicationServer": { + "properties": { + "ipAddress": { + "description": "", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "udpPort": { + "description": "", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + } + }, + "required": ["ipAddress", "udpPort"], + "type": "object", + "x-etsi-ref": "6.5.8" + }, + "V2xMsgNotification": { + "properties": { + "_links": { + "$ref": "#/components/schemas/_links3" + }, + "msgContent": { + "description": "Published V2X message content. The format of the string is defined by the standardization organization indicated by the attribute stdOrganization of the msgPropertiesValues attribute.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "msgPropertiesValues": { + "$ref": "#/components/schemas/V2xMsgPropertiesValues" + }, + "msgRepresentationFormat": { + "description": "The representation format of the binary V2X message, for example base64 or hexadecimal representation.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "notificationType": { + "description": "Shall be set to \"V2xMsgNotification\".", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "timeStamp": { + "$ref": "#/components/schemas/TimeStamp" + } + }, + "required": [ + "notificationType", + "timeStamp", + "msgPropertiesValues", + "msgRepresentationFormat", + "msgContent", + "_links" + ], + "type": "object", + "x-etsi-ref": "6.4.5" + }, + "V2xMsgNotification.links": { + "description": "links to resources related to this notification.", + "properties": { + "subscription": { + "$ref": "#/components/schemas/LinkType" + } + }, + "required": ["subscription"], + "type": "object", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Structure (inlined)" + }, + "V2xMsgPublication": { + "properties": { + "msgContent": { + "description": "Published V2X message content. Its format is defined by the standardization organization indicated by the attribute stdOrganization of the msgPropertiesValues attribute.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "msgPropertiesValues": { + "$ref": "#/components/schemas/V2xMsgPropertiesValues" + }, + "msgRepresentationFormat": { + "description": "The representation format of the binary V2X message, for example base64 or hexadecimal representation.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + } + }, + "required": [ + "msgPropertiesValues", + "msgRepresentationFormat", + "msgContent" + ], + "type": "object", + "x-etsi-ref": "6.2.7" + }, + "msgType": { + "description": "Published V2X message type. Its value is defined by the standardization organization indicated by the attribute stdOrganization. See note 2.\n− denm(1): Decentralized Environmental Notification Message (DENM) as specified in ETSI EN 302 637-3,\n− cam(2): Cooperative Awareness Message (CAM) as specified in ETSI EN 302 637-2,\n− poi(3): Point of Interest message as specified in ETSI TS 101 556-1,\n− spatem(4): Signal Phase And Timing (SPAT) message as specified in SAE J2735 and in ETSI TS 103 301,\n− mapem(5): MAP message as specified in SAE J2735 and in ETSI TS 103 301,\n− ivim(6): In Vehicle Information (IVI) message as defined in ISO TS 19321,\n− ev-rsr(7): Electric vehicle recharging spot reservation message, as defined in ETSI TS 101 556-3,\n− tistpgtransaction(8): messages for Tyre Information System (TIS) and Tyre Pressure Gauge (TPG) interoperability, as specified in ETSI TS 101 556-2,\n− srem(9): Traffic light Signal Request Message as specified in ETSI TS 103 301,\n− ssem(10): Traffic Light Signal Request Status Message as specified in ETSI TS 103 301.\n− evcsn(11): Electrical Vehicle Charging Spot Notification message as specified in ETSI TS 101 556-1,\n− saem(12): Services Announcement Extended Message as specified in ETSI TS 102 890-1,\n− rtcmem(13): Radio Technical Commission for Maritime Services (RTCM) Message as specified in ETSI TS 103 301,\n", + "enum": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13], + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Enum" + }, + "V2xMsgSubscription": { + "properties": { + "_links": { + "$ref": "#/components/schemas/_links" + }, + "callbackReference": { + "description": "URI exposed by the client on which to receive notifications via HTTP. See note.", + "format": "uri", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uri" + }, + "expiryDeadline": { + "$ref": "#/components/schemas/TimeStamp" + }, + "filterCriteria": { + "$ref": "#/components/schemas/V2xMsgFilterCriteria" + }, + "requestTestNotification": { + "description": "Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as described in ETSI GS MEC 009 [9], clause 6.12a. \nDefault: FALSE.", + "type": "boolean", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Boolean" + }, + "subscriptionType": { + "description": "Shall be set to \"V2xMsgSubscription\".", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "websockNotifConfig": { + "$ref": "#/components/schemas/WebsockNotifConfig" + } + }, + "required": ["subscriptionType", "filterCriteria"], + "type": "object", + "anyOf": [ + { + "oneOf": [ + { + "required": ["callbackReference"] + }, + { + "required": ["websockNotifConfig"] + } + ] + } + ], + "x-etsi-notes": "NOTE:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to VIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009 [9], clause 6.12a.", + "x-etsi-ref": "6.3.5" + }, + "V2xMsgSubscription.filterCriteria": { + "description": "List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response.", + "properties": { + "msgType": { + "description": "Subscribed V2X message type. Its value is defined by the standardization organization indicated by the attribute stdOrganization. See note 3.", + "items": { + "type": "string" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "Enum" + }, + "stdOrganization": { + "description": "Standardization organization which defines the subscribed V2X message type: \nETSI: European Telecommunications Standards Institute. \nSee note 2.", + "enum": ["ETSI"], + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Enum" + } + }, + "required": ["stdOrganization"], + "type": "object", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Structure (inlined)" + }, + "V2xServerUsd": { + "properties": { + "sdpInfo": { + "$ref": "#/components/schemas/V2xServerUsd.sdpInfo" + }, + "serviceAreaIdentifier": { + "description": "A list of service area identifier for the applicable MBMS broadcast area.", + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array", + "x-etsi-mec-cardinality": "1..N", + "x-etsi-mec-origin-type": "String" + }, + "tmgi": { + "$ref": "#/components/schemas/V2xServerUsd.tmgi" + } + }, + "required": ["tmgi", "serviceAreaIdentifier", "sdpInfo"], + "type": "object", + "x-etsi-ref": "6.5.10" + }, + "V2xServerUsd.sdpInfo": { + "description": "SDP with IP multicast address and port number used for V2X communication via MBMS.", + "properties": { + "ipMulticastAddress": { + "description": "", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "portNumber": { + "description": "", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + } + }, + "required": ["ipMulticastAddress", "portNumber"], + "type": "object", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Structure (inlined)" + }, + "V2xServerUsd.tmgi": { + "description": "Temporary Mobile Group Identity (TMGI), which is used within MBMS to uniquely identify Multicast and Broadcast bearer services.", + "properties": { + "mbmsServiceId": { + "description": "MBMS Service ID consisting of three octets.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "mcc": { + "description": "The Mobile Country Code part of PLMN Identity.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "mnc": { + "description": "The Mobile Network Code part of PLMN Identity.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + } + }, + "required": ["mbmsServiceId", "mcc", "mnc"], + "type": "object", + "x-etsi-mec-cardinality": "", + "x-etsi-mec-origin-type": "Structure (inlined)" + }, + "WebsockNotifConfig": { + "properties": { + "requestWebsocketUri": { + "description": "Set to TRUE by the service consumer to indicate that Websocket delivery is requested.", + "type": "boolean", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Boolean" + }, + "websocketUri": { + "description": "Set by VIS to indicate to the service consumer the Websocket URI to be used for delivering notifications.", + "format": "uri", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uri" + } + }, + "type": "object", + "x-etsi-ref": "6.5.18" + }, + "V2xMsgDistributionServerInfo": { + "properties": { + "locationInfo": { + "description": "Location information to identify a particular geographical area of interest to the service consumer for receiving V2X messages.", + "items": { + "$ref": "#/components/schemas/LocationInfo" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "LocationInfo" + }, + "v2xMsgDistributionServer": { + "description": "Describes the information of the V2X Message Distribution Servers supported by the service consumer for direct communication.", + "items": { + "$ref": "#/components/schemas/V2xMsgDistributionServer" + }, + "minItems": 1, + "type": "array", + "x-etsi-mec-cardinality": "1..N", + "x-etsi-mec-origin-type": "V2xMsgDistributionServer" + } + }, + "required": ["v2xMsgDistributionServer"], + "type": "object", + "x-etsi-ref": "6.2.5" + }, + "PredQosSubscription": { + "properties": { + "_links": { + "$ref": "#/components/schemas/_links1" + }, + "callbackReference": { + "description": "URI exposed by the client on which to receive notifications via HTTP. See note.", + "format": "uri", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uri" + }, + "expiryDeadline": { + "$ref": "#/components/schemas/TimeStamp" + }, + "filterCriteria": { + "$ref": "#/components/schemas/QosPredFilterCriteria" + }, + "requestTestNotification": { + "description": "Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as described in ETSI GS MEC 009 [9], clause 6.12a. \nDefault: FALSE.", + "type": "boolean", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Boolean" + }, + "subscriptionType": { + "description": "Shall be set to \"PredQosSubscription\".", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "websockNotifConfig": { + "$ref": "#/components/schemas/WebsockNotifConfig" + } + }, + "required": ["subscriptionType", "filterCriteria"], + "type": "object", + "anyOf": [ + { + "oneOf": [ + { + "required": ["callbackReference"] + }, + { + "required": ["websockNotifConfig"] + } + ] + } + ], + "x-etsi-notes": "NOTE:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to VIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009 [9], clause 6.12a.", + "x-etsi-ref": "6.3.6" + }, + "V2xMsgPropertiesValues": { + "properties": { + "locationInfo": { + "$ref": "#/components/schemas/LocationInfo" + }, + "msgProtocolVersion": { + "description": "Protocol version of the V2X message (0..255),\nSee note 3.", + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Integer" + }, + "msgType": { + "description": "Published V2X message type. Its value is defined by the standardization organization indicated by the attribute stdOrganization. See note 2.", + "enum": ["SEE_DESCRIPTION"], + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Enum" + }, + "stdOrganization": { + "description": "Standardization organization which defines the published V2X message type: \nETSI: European Telecommunications Standards Institute. \nSee note 1.", + "enum": ["SEE_DESCRIPTION"], + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Enum" + } + }, + "required": [ + "stdOrganization", + "msgType", + "msgProtocolVersion", + "locationInfo" + ], + "type": "object", + "x-etsi-notes": "NOTE 1:\tOther standardization organizations could be added as needed.\nNOTE 2:\tThe V2X message types of ETSI shall be used as specified in ETSI TS 102 894-2 [6], clause A.114.\nNOTE 3:\tThe message protocol version of ETSI shall be used as specified in ETSI TS 102 894-2 [6], clause A.114.", + "x-etsi-ref": "6.5.14" + }, + "V2xMsgFilterCriteria": { + "properties": { + "locationInfo": { + "description": "Location information to identify a cell of a base station or a particular geographical area to which the V2X message can be associated.", + "items": { + "$ref": "#/components/schemas/LocationInfo" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "LocationInfo" + }, + "msgProtocolVersion": { + "description": "Protocol version of the V2X message (0..255),\nSee note 3.", + "items": { + "type": "integer" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "Integer" + }, + "msgType": { + "description": "Published V2X message type. Its value is defined by the standardization organization indicated by the attribute stdOrganization. See note 2.", + "items": { + "enum": ["SEE_DESCRIPTION"], + "type": "string" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "Enum" + }, + "stdOrganization": { + "description": "Standardization organization which defines the published V2X message type: \nETSI: European Telecommunications Standards Institute. \nSee note 1.", + "enum": ["SEE_DESCRIPTION"], + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Enum" + } + }, + "required": ["stdOrganization"], + "type": "object", + "x-etsi-notes": "NOTE 1:\tOther standardization organizations could be added as needed.\nNOTE 2:\tThe V2X message types of ETSI shall be used as specified in ETSI TS 102 894-2 [6], clause A.114.\nNOTE 3:\tThe message protocol version of ETSI shall be used as specified in ETSI TS 102 894-2 [6], clause A.114.", + "x-etsi-ref": "6.5.15" + }, + "V2xMsgDistributionServer": { + "properties": { + "infoConnection": { + "$ref": "#/components/schemas/InfoConnection" + }, + "infoProtocol": { + "$ref": "#/components/schemas/InfoProtocol" + } + }, + "required": ["infoProtocol"], + "type": "object", + "x-etsi-notes": "NOTE:\tOther application layer protocols (and versions thereof) may be added as needed.", + "x-etsi-ref": "6.5.16" + }, + "InfoConnection": { + "description": "Connection information of the V2X Message Distribution Server the service consumer can use for direct connection. Shall only be included in the response.", + "properties": { + "ipAddress": { + "description": "IP address of the V2X Message Distribution Server.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "port_number": { + "description": "Port number of the V2X Message Distribution Server.", + "x-etsi-mec-cardinality'": "1", + "x-etsi-mec-origin-type'": "Integer (0..65535)", + "type": "integer" + } + }, + "required": ["ipAddress", "port_number"], + "type": "object", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Structure (inlined)" + }, + "InfoProtocol": { + "description": "Specifics of the application layer protocol of V2X Message Distribution Server.", + "properties": { + "msgProtocol": { + "description": "Numerical value corresponding to the application layer protocol supported by the service consumer. For the msgProtocol, the following values are currently defined (see note):\n\n0 = MQTT v3.1.0\n1 = MQTT v3.1.1\n2 = MQTT v5\n3 = MQTT-SN\n4 = AMQP 1.0", + "items": { + "enum": [0, 1, 2, 3, 4], + "type": "integer" + }, + "minItems": 1, + "type": "array", + "x-etsi-mec-cardinality": "1..N", + "x-etsi-mec-origin-type": "Enum" + }, + "protImplementation": { + "description": "Implementation specifics of application layer protocol, e.g. programming language.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + } + }, + "required": ["msgProtocol", "protImplementation"], + "type": "object", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Structure (inlined)" + }, + "QosPredFilterCriteria": { + "properties": { + "streamId": { + "description": "The predicted QoS at the related time and vehicular UE location is provided for a specific data stream. In case of 3GPP network, this is mapped to a QoS flow. Stream needs to also contain the stream ID which, in case of the 3GPP network, can be mapped on to the 5QI or QCI.\nSee note.", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + } + }, + "type": "object", + "x-etsi-notes": "NOTE:\tOther identifiers could be added as needed.", + "x-etsi-ref": "6.5.17" + }, + "PredictionArea": { + "description": "Geographical area including the two ends of the user plane link between two V2X application instances.\n\nIt shall only be present when \"predictionTarget\" = \"E2E_APPLICATION_INSTANCE_PREDICTION\".", + "properties": { + "center": { + "$ref": "#/components/schemas/LocationInfo" + }, + "radius": { + "description": "Radius of geographical area including the two ends of the user plane link between two V2X application instances. Measured in meters.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + } + }, + "required": ["center", "radius"], + "type": "object", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Structure (inlined)" + }, + "Qos": { + "description": "Predicted QoS at the related time and vehicular UE location. Shall only be included in the response.", + "properties": { + "stream": { + "items": { + "$ref": "#/components/schemas/Stream" + }, + "type": "array" + } + }, + "required": ["stream"], + "type": "object", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Structure (inlined)" + }, + "Stream": { + "description": "Predicted QoS at the related time and vehicular UE location for the specific data stream. In case of 3GPP network, this is mapped to a QoS flow. Stream needs to also contain the stream ID that, in case of the 3GPP network, can be mapped on to the 5QI or QCI.", + "minItems": 1, + "properties": { + "qosKpi": { + "items": { + "$ref": "#/components/schemas/QosKpi" + }, + "type": "array" + } + }, + "required": ["qosKpi"], + "type": "object", + "x-etsi-mec-cardinality": "1..N", + "x-etsi-mec-origin-type": "Structure (inlined)" + }, + "QosKpi": { + "description": "This structure contains the prediction for a specific QoS KPI related to a given data stream.", + "minItems": 1, + "properties": { + "confidence": { + "description": "Confidence of the prediction, as returned by the relevant domain PF. The value and the measurement of the confidence depends on the SLA. Shall only be included in the response.", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "kpiName": { + "description": "The name of the KPI (e.g. latency, UL bitrate, etc). It can be included in the request and in the response.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "kpiValue": { + "description": "Information on the predicted value for the specific QoS KPI. It can be in different forms, such as upper bound and lower bound, CDF, actual value, etc. Shall only be included in the response.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + } + }, + "required": ["kpiName", "kpiValue"], + "type": "object", + "x-etsi-mec-cardinality": "1..N", + "x-etsi-mec-origin-type": "Structure (inlined)" + }, + "Routes": { + "description": "Information relating to the potential routes of a vehicular UE. Shall only be present when \"predictionTarget\" = \"SINGLE_UE_PREDICTION\".", + "minItems": 0, + "properties": { + "routeInfo": { + "items": { + "$ref": "#/components/schemas/RouteInfo" + }, + "type": "array" + } + }, + "required": ["routeInfo"], + "type": "object", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "Structure (inlined)" + }, + "RouteInfo": { + "description": "Information relating to a specific route.\nThe first structure shall relate to the route origin and the last to the route destination. Intermediate waypoint locations may also be provided.", + "minItems": 1, + "properties": { + "location": { + "$ref": "#/components/schemas/LocationInfo" + }, + "time": { + "$ref": "#/components/schemas/TimeStamp" + } + }, + "required": ["location"], + "type": "object", + "x-etsi-mec-cardinality": "1..N", + "x-etsi-mec-origin-type": "Structure (inlined)" + }, + "_links": { + "description": "Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.", + "properties": { + "self": { + "$ref": "#/components/schemas/LinkType" + } + }, + "required": ["self"], + "type": "object", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Structure (inlined)" + }, + "_links1": { + "description": "Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.", + "properties": { + "self": { + "$ref": "#/components/schemas/LinkType" + } + }, + "required": ["self"], + "type": "object", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Structure (inlined)" + }, + "_links2": { + "description": "List of hyperlinks related to the resource.", + "properties": { + "self": { + "$ref": "#/components/schemas/LinkType" + }, + "subscriptions": { + "items": { + "$ref": "#/components/schemas/Subscriptions" + }, + "type": "array" + } + }, + "required": ["self"], + "type": "object", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Structure (inlined)" + }, + "_links3": { + "description": "Links to resources related to this notification.", + "properties": { + "subscription": { + "$ref": "#/components/schemas/LinkType" + } + }, + "required": ["subscription"], + "type": "object", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Structure (inlined)" + }, + "Subscriptions": { + "description": "The service consumer's subscriptions.", + "minItems": 0, + "properties": { + "href": { + "description": "The URI referring to the subscription.", + "format": "uri", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Uri" + }, + "subscriptionType": { + "description": "Type of the subscription. The values are as defined in the \"subscriptionType\" attribute for each different V2X information event subscription data type.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + } + }, + "required": ["href", "subscriptionType"], + "type": "object", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "Structure (inlined)" + } + }, + "responses": { + "204": { + "description": "No Content" + }, + "206": { + "description": "Partial content" + }, + "400": { + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized : used when the client did not submit credentials.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "406": { + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "412": { + "description": "Precondition failed : used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "415": { + "description": "Unsupported Media Type : used to indicate that the server or the client does not support the content type of the entity body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "422": { + "description": "Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "429": { + "description": "Too Many Requests : used when a rate limiter has triggered.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } +} \ No newline at end of file diff --git a/MEC030_V2XInformationService.yaml b/MEC030_V2XInformationServices.yaml similarity index 74% rename from MEC030_V2XInformationService.yaml rename to MEC030_V2XInformationServices.yaml index 0b1fd108567b6c580228442ea4c5f13b040b2f64..ce39435fdccea6b14bcae457ce6b00966fa672fd 100644 --- a/MEC030_V2XInformationService.yaml +++ b/MEC030_V2XInformationServices.yaml @@ -1,8 +1,8 @@ openapi: 3.1.0 info: - title: 'ETSI GS MEC 030 V2X Information Service API' - version: 2.1.9 - description: 'ETSI GS MEC 030 V2X Information Service API described using OpenAPI.' + title: 'ETSI GS MEC 030 V2X Information Services API' + version: 3.1.1 + description: 'ETSI GS MEC 030 V2X Information Services API described using OpenAPI.' contact: name: ETSI Forge email: cti_support@etsi.org @@ -11,8 +11,8 @@ info: name: BSD-3-Clause url: 'https://forge.etsi.org/legal-matters' externalDocs: - description: 'ETSI GS MEC 030 V2X Information Service API, v2.1.9' - url: '' + description: 'ETSI GS MEC 030 V2X Information Services API, v3.1.1' + url: 'https://www.etsi.org/deliver/etsi_gs/MEC/001_099/030/03.01.01_60/gs_mec030v030101p.pdf' servers: - url: 'https://localhost/vis/v2' tags: @@ -128,6 +128,35 @@ paths: '429': $ref: '#/components/responses/429' + /provide_v2x_msg_distribution_server_info: + post: + tags: + - 'V2X_msg' + summary: 'Request the information about available V2X Message Distribution Servers that can be supported by the service consumer.' + description: 'Request the information about available V2X Message Distribution Servers that can be supported by the service consumer (e.g. a MEC application).' + operationId: v2xMsg_distributionServerPost + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/V2xMsgDistributionServerInfo' + responses: + '200': + description: 'The response body shall contain the connection information of the V2X Message Distribution Servers that the service consumer can use for direct connection.' + content: + application/json: + schema: + $ref: '#/components/schemas/V2xMsgDistributionServerInfo' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + /provide_predicted_qos: post: tags: @@ -196,7 +225,7 @@ paths: parameters: - in: query name: subscription_type - description: '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' + description: '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. pred_qos: information on the predicted QoS' schema: type: string required: false @@ -312,6 +341,7 @@ paths: - $ref: '#/components/schemas/ProvChgUuMbmsSubscription' - $ref: '#/components/schemas/ProvChgPc5Subscription' - $ref: '#/components/schemas/V2xMsgSubscription' + - $ref: '#/components/schemas/PredQosSubscription' '400': $ref: '#/components/responses/400' '401': @@ -341,6 +371,7 @@ paths: - $ref: '#/components/schemas/ProvChgUuMbmsSubscription' - $ref: '#/components/schemas/ProvChgPc5Subscription' - $ref: '#/components/schemas/V2xMsgSubscription' + - $ref: '#/components/schemas/PredQosSubscription' responses: '200': description: 'A response body containing data type describing the updated subscription is returned' @@ -352,6 +383,7 @@ paths: - $ref: '#/components/schemas/ProvChgUuMbmsSubscription' - $ref: '#/components/schemas/ProvChgPc5Subscription' - $ref: '#/components/schemas/V2xMsgSubscription' + - $ref: '#/components/schemas/PredQosSubscription' '400': $ref: '#/components/responses/400' '401': @@ -374,6 +406,7 @@ paths: '429': $ref: '#/components/responses/429' + delete: tags: - 'subscription' @@ -408,6 +441,7 @@ components: - cellId type: object x-etsi-ref: 6.6.2 + Earfcn: properties: earfcn: @@ -419,6 +453,7 @@ components: - earfcn type: object x-etsi-ref: 6.6.3 + Ecgi: properties: cellId: @@ -436,6 +471,7 @@ components: - cellId type: object x-etsi-ref: 6.5.5 + FddInfo: properties: dlEarfcn: @@ -465,11 +501,12 @@ components: - dlTransmissionBandwidth type: object x-etsi-ref: 6.5.6 + links: description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests. properties: self: - # description': Self-referring URI. The URI shall be unique within the VIS API as it acts as an ID for the subscription. + # description': Self-referring URI. The URI shall be unique within the V2X API as it acts as an ID for the subscription. # x-etsi-mec-cardinality': '1' # x-etsi-mec-origin-type': LinkType $ref: '#/components/schemas/LinkType' @@ -478,6 +515,7 @@ components: type: object x-etsi-mec-cardinality: 0..1 x-etsi-mec-origin-type: Structure (inlined) + LinkType: properties: href: @@ -490,6 +528,7 @@ components: - href type: object x-etsi-ref: 6.5.13 + LocationInfo: properties: ecgi: @@ -502,6 +541,7 @@ components: type: object x-etsi-notes: "NOTE:\tEither ecgi or geoArea shall be present, but not both." x-etsi-ref: 6.5.3 + LocationInfo.geoArea: description: Information of a geographical area. properties: @@ -523,6 +563,7 @@ components: type: object x-etsi-mec-cardinality: 0..1 x-etsi-mec-origin-type: Structure (inlined) + Pc5NeighbourCellInfo: properties: ecgi: @@ -546,6 +587,7 @@ components: - siV2xConfig type: object x-etsi-ref: 6.5.12 + Pc5ProvisioningInfo: properties: proInfoPc5: @@ -562,6 +604,7 @@ components: - proInfoPc5 type: object x-etsi-ref: 6.2.4 + Pc5ProvisioningInfo.proInfoPc5: description: The provisioning information per location as defined below. type: object @@ -606,6 +649,7 @@ components: - mnc type: object x-etsi-ref: 6.5.4 + PredictedQos: properties: locationGranularity: @@ -613,27 +657,39 @@ components: type: string x-etsi-mec-cardinality: '1' x-etsi-mec-origin-type: String + noticePeriod: + # description': Information on when the predicted QoS is needed at the service consumer interface. The value of the notice period depends on the application reaction that has to be triggered by the service consumer. The value of the notice period shall be equal or a multiple of the timeGranularity, if it is present. If present, it shall only be included in the request. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': TimeStamp + $ref: '#/components/schemas/TimeStamp' + predictionArea: + $ref: '#/components/schemas/PredictionArea' + predictionTarget: + description: "Indicates target of QoS prediction. Valid values:\n\n1.\tSINGLE_UE_PREDICTION: \nThe predicted QoS is to be intended as journey-specific for a requesting vehicular UE.\n\n2.\tE2E_APPLICATION_INSTANCE_PREDICTION:\nThe E2E user plane link between two V2X application instances, where one instance relates to a single vehicular UE and the other instance to an application instance within another network, i.e. either another vehicular UE as in the V2N2V case, or an infrastructure element as in the V2N2I case.\n\nShall only be included in the request.\n\n" + enum: + - SEE_DESCRIPTION + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Enum_inlined + qos: + $ref: '#/components/schemas/Qos' routes: - description: Information relating to the potential routes of a vehicular UE. items: - $ref: '#/components/schemas/PredictedQos.routes' - minItems: 1 - required: - - routeInfo + $ref: '#/components/schemas/Routes' type: array - x-etsi-mec-cardinality: 1..N - x-etsi-mec-origin-type: Structure (inlined) timeGranularity: # description': Time granularity of visiting a location. # x-etsi-mec-cardinality': 0..1 # x-etsi-mec-origin-type': TimeStamp $ref: '#/components/schemas/TimeStamp' required: - - locationGranularity - - routes + - predictionTarget + - locationGranularity + - qos type: object x-etsi-notes: "NOTE:\tThe data type of locationGranularity is a string which indicates the granularity of a visited location by means of latitudinal and longitudinal margins." - x-etsi-ref: 6.2.5 + x-etsi-ref: 6.2.6 + PredictedQos.routes: properties: routeInfo: @@ -650,6 +706,7 @@ components: x-etsi-mec-origin-type: Structure (inlined) type: object minItems: 1 + PredictedQos.routes.routeInfo: type: object properties: @@ -681,6 +738,7 @@ components: # x-etsi-mec-cardinality': 0..1 # x-etsi-mec-origin-type': TimeStamp $ref: '#/components/schemas/TimeStamp' + ProblemDetails: properties: detail: @@ -712,6 +770,7 @@ components: x-etsi-mec-cardinality: 0..1 x-etsi-mec-origin-type: URI type: object + ProvChgPc5Notification: properties: dstLayer2Id: @@ -747,6 +806,7 @@ components: - locationInfo type: object x-etsi-ref: 6.4.4 + ProvChgPc5Subscription: properties: _links: @@ -783,8 +843,15 @@ components: - subscriptionType - filterCriteria type: object + anyOf: + - oneOf: + - required: + - callbackReference + - required: + - websockNotifConfig x-etsi-notes: 'NOTE: At least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to VIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009 [i.1], clause 6.12a.' x-etsi-ref: 6.3.4 + ProvChgPc5Subscription.filterCriteria: description: List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response. properties: @@ -812,6 +879,7 @@ components: type: object x-etsi-mec-cardinality: '1' x-etsi-mec-origin-type: Structure (inlined) + ProvChgUuMbmsNotification: properties: locationInfo: @@ -847,6 +915,7 @@ components: - locationInfo type: object x-etsi-ref: 6.4.3 + ProvChgUuMbmsSubscription: properties: _links: @@ -883,8 +952,15 @@ components: - subscriptionType - filterCriteria type: object + anyOf: + - oneOf: + - required: + - callbackReference + - required: + - websockNotifConfig x-etsi-notes: "NOTE:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to VIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009 [i.1], clause 6.12a." x-etsi-ref: 6.3.3 + ProvChgUuMbmsSubscription.filterCriteria: description: List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response. properties: @@ -912,6 +988,7 @@ components: type: object x-etsi-mec-cardinality: '1' x-etsi-mec-origin-type: Structure (inlined) + ProvChgUuUniNotification: properties: locationInfo: @@ -947,6 +1024,7 @@ components: - locationInfo type: object x-etsi-ref: 6.4.2 + ProvChgUuUniSubscription: properties: _links: @@ -983,8 +1061,15 @@ components: - subscriptionType - filterCriteria type: object + anyOf: + - oneOf: + - required: + - callbackReference + - required: + - websockNotifConfig x-etsi-notes: "NOTE:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to VIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009 [i.1], clause 6.12a." x-etsi-ref: 6.3.2 + ProvChgUuUniSubscription.filterCriteria: description: List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response. properties: @@ -1012,14 +1097,15 @@ components: type: object x-etsi-mec-cardinality: '1' x-etsi-mec-origin-type: Structure (inlined) + SubscriptionLinkList: properties: _links: - $ref: '#/components/schemas/SubscriptionLinkList.links' + $ref: '#/components/schemas/_links2' required: - - _links + - _links type: object - x-etsi-ref: 6.3.6 + x-etsi-ref: 6.3.7 SystemInformationBlockType21: type: object TddInfo: @@ -1045,44 +1131,7 @@ components: - subframeAssignment type: object x-etsi-ref: 6.5.7 - SubscriptionLinkList.links: - description: List of hyperlinks related to the resource. - properties: - self: - # description': URI of this resource. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': LinkType - $ref: '#/components/schemas/LinkType' - subscriptions: - type: array - items: - $ref: '#/components/schemas/SubscriptionLinkList.links.subscriptions' - required: - - self - type: object - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Structure (inlined) - SubscriptionLinkList.links.subscriptions: - description: The service consumer's subscriptions. - type: object - minItems: 0 - properties: - href: - description: The URI referring to the subscription. - format: uri - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: URI - subscriptionType: - description: Type of the subscription. The values are as defined in the "subscriptionType" attribute for each different V2X information event subscription data type. - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String - required: - - href - - subscriptionType - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: Structure (inlined) + TestNotification: properties: _links: @@ -1108,6 +1157,7 @@ components: - _links type: object x-etsi-ref: 6.4.6 + TimeStamp: properties: nanoSeconds: @@ -1127,6 +1177,7 @@ components: - nanoSeconds type: object x-etsi-ref: 6.5.2 + TransmissionBandwidth: properties: transmissionBandwidth: @@ -1135,6 +1186,7 @@ components: - transmissionBandwidth type: object x-etsi-ref: 6.6.4 + TransmissionBandwidth.transmissionBandwidth: description: | 'Numeric value corresponding to the transmission bandwidth expressed in units of resource blocks as follows: @@ -1160,6 +1212,7 @@ components: type: integer x-etsi-mec-cardinality: '1' x-etsi-mec-origin-type: Enum + UuMbmsNeighbourCellInfo: properties: ecgi: @@ -1204,6 +1257,7 @@ components: - mbmsServiceAreaIdentity type: object x-etsi-ref: 6.5.11 + UuMbmsProvisioningInfo: properties: proInfoUuMbms: @@ -1220,6 +1274,7 @@ components: - proInfoUuMbms type: object x-etsi-ref: 6.2.3 + UuMbmsProvisioningInfo.proInfoUuMbms: description: The provisioning information per location as defined below. type: object @@ -1247,6 +1302,7 @@ components: - v2xServerUsd x-etsi-mec-cardinality: 1..N x-etsi-mec-origin-type: Structure (inlined) + UuUniNeighbourCellInfo: properties: ecgi: @@ -1282,6 +1338,7 @@ components: - tddInfo type: object x-etsi-ref: 6.5.9 + UuUnicastProvisioningInfo: properties: proInfoUuUnicast: @@ -1298,6 +1355,7 @@ components: - proInfoUuUnicast type: object x-etsi-ref: 6.2.2 + UuUnicastProvisioningInfo.proInfoUuUnicast: description: The provisioning information per location as defined below. type: object @@ -1325,6 +1383,7 @@ components: - v2xApplicationServer x-etsi-mec-cardinality: 1..N x-etsi-mec-origin-type: Structure (inlined) + V2xApplicationServer: properties: ipAddress: @@ -1342,49 +1401,44 @@ components: - udpPort type: object x-etsi-ref: 6.5.8 + V2xMsgNotification: properties: _links: - $ref: '#/components/schemas/V2xMsgNotification.links' + $ref: '#/components/schemas/_links3' msgContent: - description: Published V2X message content. The format of the string is defined by the standardization organization indicated by the attribute stdOrganization. + description: Published V2X message content. The format of the string is defined by the standardization organization indicated by the attribute stdOrganization of the msgPropertiesValues attribute. type: string x-etsi-mec-cardinality: '1' x-etsi-mec-origin-type: String - msgEncodeFormat: - description: The encode format of the V2X message, for example base64. + msgPropertiesValues: + # description': List of message properties that is associated to the V2X message. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': V2xMsgPropertiesValues + $ref: '#/components/schemas/V2xMsgPropertiesValues' + msgRepresentationFormat: + description: The representation format of the binary V2X message, for example base64 or hexadecimal representation. type: string x-etsi-mec-cardinality: '1' x-etsi-mec-origin-type: String - msgType: - $ref: '#/components/schemas/msgType' notificationType: description: Shall be set to "V2xMsgNotification". type: string x-etsi-mec-cardinality: '1' x-etsi-mec-origin-type: String - stdOrganization: - description: "Standardization organization which defines the published V2X message type: \nETSI: European Telecommunications Standards Institute.\nSee note 1." - enum: - - ETSI - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Enum timeStamp: # description': Date and time of the notification generation. # x-etsi-mec-cardinality': '1' # x-etsi-mec-origin-type': TimeStamp $ref: '#/components/schemas/TimeStamp' required: - - notificationType - - timeStamp - - stdOrganization - - msgType - - msgEncodeFormat - - msgContent - - _links + - notificationType + - timeStamp + - msgPropertiesValues + - msgRepresentationFormat + - msgContent + - _links type: object - x-etsi-notes: "NOTE 1:\tOther standardization organizations could be added as needed.\nNOTE 2:\tThe V2X message types of ETSI shall be used as specified in ETSI TS 102 894-2 [6], clause A.114." x-etsi-ref: 6.4.5 V2xMsgNotification.links: description: links to resources related to this notification. @@ -1399,35 +1453,31 @@ components: type: object x-etsi-mec-cardinality: '1' x-etsi-mec-origin-type: Structure (inlined) + V2xMsgPublication: properties: msgContent: - description: Published V2X message content. Its format is defined by the standardization organization indicated by the attribute stdOrganization. + description: Published V2X message content. Its format is defined by the standardization organization indicated by the attribute stdOrganization of the msgPropertiesValues attribute. type: string x-etsi-mec-cardinality: '1' x-etsi-mec-origin-type: String - msgEncodeFormat: - description: The encode format of the V2X message, for example base64. + msgPropertiesValues: + # description': List of message properties that is associated to the V2X message publication that can be used for filtering messages at the reception of the V2X message. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': V2xMsgPropertiesValues + $ref: '#/components/schemas/V2xMsgPropertiesValues' + msgRepresentationFormat: + description: The representation format of the binary V2X message, for example base64 or hexadecimal representation. type: string x-etsi-mec-cardinality: '1' x-etsi-mec-origin-type: String - msgType: - $ref: '#/components/schemas/msgType' - stdOrganization: - description: "Standardization organization which defines the published V2X message type:\nETSI: European Telecommunications Standards Institute. \nSee note 1." - enum: - - ETSI - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Enum required: - - stdOrganization - - msgType - - msgEncodeFormat - - msgContent + - msgPropertiesValues + - msgRepresentationFormat + - msgContent type: object - x-etsi-notes: "NOTE 1:\tOther standardization organizations could be added as needed.\nNOTE 2:\tThe V2X message types of ETSI shall be used as specified in ETSI TS 102 894-2 [6], clause A.114." - x-etsi-ref: 6.2.6 + x-etsi-ref: 6.2.7 + msgType: description: | Published V2X message type. Its value is defined by the standardization organization indicated by the attribute stdOrganization. See note 2. @@ -1461,12 +1511,13 @@ components: type: integer x-etsi-mec-cardinality: '1' x-etsi-mec-origin-type: Enum + V2xMsgSubscription: properties: _links: - $ref: '#/components/schemas/links' + $ref: '#/components/schemas/_links' callbackReference: - description: URI exposed by the client on which to receive notifications via HTTP. See note 1. + description: URI exposed by the client on which to receive notifications via HTTP. See note. format: uri type: string x-etsi-mec-cardinality: 0..1 @@ -1477,9 +1528,12 @@ components: # x-etsi-mec-origin-type': TimeStamp $ref: '#/components/schemas/TimeStamp' filterCriteria: - $ref: '#/components/schemas/V2xMsgSubscription.filterCriteria' + # description': List of filtering criteria aimed to filter V2X messages at the reception. Any filtering criteria which is included in the request, shall also be included in the response. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': V2xMsgFilterCriteria + $ref: '#/components/schemas/V2xMsgFilterCriteria' requestTestNotification: - description: "Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as described in ETSI GS\_MEC 009 [i.1], clause 6.12a.\nDefault: FALSE." + description: "Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as described in ETSI GS MEC 009 [9], clause 6.12a. \nDefault: FALSE." type: boolean x-etsi-mec-cardinality: 0..1 x-etsi-mec-origin-type: Boolean @@ -1489,16 +1543,23 @@ components: x-etsi-mec-cardinality: '1' x-etsi-mec-origin-type: String websockNotifConfig: - # description': Provides details to negotiate and signal the use of a Websocket connection between VIS and the service consumer for notifications. See note 1. + # description': Provides details to negotiate and signal the use of a Websocket connection between VIS and the service consumer for notifications. See note. # x-etsi-mec-cardinality': 0..1 # x-etsi-mec-origin-type': WebsockNotifConfig $ref: '#/components/schemas/WebsockNotifConfig' required: - - subscriptionType - - filterCriteria + - subscriptionType + - filterCriteria type: object - x-etsi-notes: "NOTE 1:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to VIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009 [i.1], clause 6.12a.\nNOTE 2:\tOther standardization organizations could be added as needed.\nNOTE 3:\tThe V2X message types of ETSI shall be used as specified in ETSI TS 102 894-2 [6], clause A.114." + anyOf: + - oneOf: + - required: + - callbackReference + - required: + - websockNotifConfig + x-etsi-notes: "NOTE:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to VIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009 [9], clause 6.12a." x-etsi-ref: 6.3.5 + V2xMsgSubscription.filterCriteria: description: List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response. properties: @@ -1522,6 +1583,7 @@ components: type: object x-etsi-mec-cardinality: '1' x-etsi-mec-origin-type: Structure (inlined) + V2xServerUsd: properties: sdpInfo: @@ -1542,6 +1604,7 @@ components: - sdpInfo type: object x-etsi-ref: 6.5.10 + V2xServerUsd.sdpInfo: description: SDP with IP multicast address and port number used for V2X communication via MBMS. properties: @@ -1561,6 +1624,7 @@ components: type: object x-etsi-mec-cardinality: '1' x-etsi-mec-origin-type: Structure (inlined) + V2xServerUsd.tmgi: description: Temporary Mobile Group Identity (TMGI), which is used within MBMS to uniquely identify Multicast and Broadcast bearer services. properties: @@ -1600,8 +1664,434 @@ components: x-etsi-mec-cardinality: 0..1 x-etsi-mec-origin-type: Uri type: object + x-etsi-ref: 6.5.18 + + V2xMsgDistributionServerInfo: + properties: + locationInfo: + description: Location information to identify a particular geographical area of interest to the service consumer for receiving V2X messages. + items: + $ref: '#/components/schemas/LocationInfo' + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: LocationInfo + v2xMsgDistributionServer: + description: Describes the information of the V2X Message Distribution Servers supported by the service consumer for direct communication. + items: + $ref: '#/components/schemas/V2xMsgDistributionServer' + minItems: 1 + type: array + x-etsi-mec-cardinality: 1..N + x-etsi-mec-origin-type: V2xMsgDistributionServer + required: + - v2xMsgDistributionServer + type: object + x-etsi-ref: 6.2.5 + + PredQosSubscription: + properties: + _links: + $ref: '#/components/schemas/_links1' + callbackReference: + description: URI exposed by the client on which to receive notifications via HTTP. See note. + format: uri + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uri + expiryDeadline: + # description': Time stamp. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': TimeStamp + $ref: '#/components/schemas/TimeStamp' + filterCriteria: + # description': List of filtering criteria aimed to filter QoS predictions at the reception. Any filtering criteria included in the request, shall also be included in the response. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': QosPredFilterCriteria + $ref: '#/components/schemas/QosPredFilterCriteria' + requestTestNotification: + description: "Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as described in ETSI GS MEC 009 [9], clause 6.12a. \nDefault: FALSE." + type: boolean + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Boolean + subscriptionType: + description: Shall be set to "PredQosSubscription". + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + websockNotifConfig: + # description': Provides details to negotiate and signal the use of a Websocket connection between VIS and the service consumer for notifications. See note. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': WebsockNotifConfig + $ref: '#/components/schemas/WebsockNotifConfig' + required: + - subscriptionType + - filterCriteria + type: object + anyOf: + - oneOf: + - required: + - callbackReference + - required: + - websockNotifConfig + x-etsi-notes: "NOTE:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to VIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009 [9], clause 6.12a." + x-etsi-ref: 6.3.6 + + V2xMsgPropertiesValues: + properties: + locationInfo: + # description': Location information to identify a cell of a base station or a particular geographical area to which the V2X message can be associated. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': LocationInfo + $ref: '#/components/schemas/LocationInfo' + msgProtocolVersion: + description: 'Protocol version of the V2X message (0..255), + + See note 3.' + type: integer + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Integer + msgType: + description: Published V2X message type. Its value is defined by the standardization organization indicated by the attribute stdOrganization. See note 2. + enum: + - SEE_DESCRIPTION + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Enum + stdOrganization: + description: "Standardization organization which defines the published V2X message type: \nETSI: European Telecommunications Standards Institute. \nSee note 1." + enum: + - SEE_DESCRIPTION + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Enum + required: + - stdOrganization + - msgType + - msgProtocolVersion + - locationInfo + type: object + x-etsi-notes: "NOTE 1:\tOther standardization organizations could be added as needed.\nNOTE 2:\tThe V2X message types of ETSI shall be used as specified in ETSI TS 102 894-2 [6], clause A.114.\nNOTE 3:\tThe message protocol version of ETSI shall be used as specified in ETSI TS 102 894-2 [6], clause A.114." x-etsi-ref: 6.5.14 + V2xMsgFilterCriteria: + properties: + locationInfo: + description: Location information to identify a cell of a base station or a particular geographical area to which the V2X message can be associated. + items: + $ref: '#/components/schemas/LocationInfo' + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: LocationInfo + msgProtocolVersion: + description: 'Protocol version of the V2X message (0..255), + + See note 3.' + items: + type: integer + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: Integer + msgType: + description: Published V2X message type. Its value is defined by the standardization organization indicated by the attribute stdOrganization. See note 2. + items: + enum: + - SEE_DESCRIPTION + type: string + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: Enum + stdOrganization: + description: "Standardization organization which defines the published V2X message type: \nETSI: European Telecommunications Standards Institute. \nSee note 1." + enum: + - SEE_DESCRIPTION + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Enum + required: + - stdOrganization + type: object + x-etsi-notes: "NOTE 1:\tOther standardization organizations could be added as needed.\nNOTE 2:\tThe V2X message types of ETSI shall be used as specified in ETSI TS 102 894-2 [6], clause A.114.\nNOTE 3:\tThe message protocol version of ETSI shall be used as specified in ETSI TS 102 894-2 [6], clause A.114." + x-etsi-ref: 6.5.15 + + V2xMsgDistributionServer: + properties: + infoConnection: + $ref: '#/components/schemas/InfoConnection' + infoProtocol: + $ref: '#/components/schemas/InfoProtocol' + required: + - infoProtocol + type: object + x-etsi-notes: "NOTE:\tOther application layer protocols (and versions thereof) may be added as needed." + x-etsi-ref: 6.5.16 + + InfoConnection: + description: Connection information of the V2X Message Distribution Server the service consumer can use for direct connection. Shall only be included in the response. + properties: + ipAddress: + description: IP address of the V2X Message Distribution Server. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + port_number: + description: Port number of the V2X Message Distribution Server. + x-etsi-mec-cardinality': '1' + x-etsi-mec-origin-type': Integer (0..65535) + type: integer + required: + - ipAddress + - port_number + type: object + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Structure (inlined) + + InfoProtocol: + description: Specifics of the application layer protocol of V2X Message Distribution Server. + properties: + msgProtocol: + description: 'Numerical value corresponding to the application layer protocol supported by the service consumer. For the msgProtocol, the following values are currently defined (see note): + 0 = MQTT v3.1.0 + 1 = MQTT v3.1.1 + 2 = MQTT v5 + 3 = MQTT-SN + 4 = AMQP 1.0' + items: + enum: + - 0 + - 1 + - 2 + - 3 + - 4 + type: integer + minItems: 1 + type: array + x-etsi-mec-cardinality: 1..N + x-etsi-mec-origin-type: Enum + protImplementation: + description: "Implementation specifics of application layer protocol, e.g.\_programming language." + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + required: + - msgProtocol + - protImplementation + type: object + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Structure (inlined) + + QosPredFilterCriteria: + properties: + streamId: + description: 'The predicted QoS at the related time and vehicular UE location is provided for a specific data stream. In case of 3GPP network, this is mapped to a QoS flow. Stream needs to also contain the stream ID which, in case of the 3GPP network, can be mapped on to the 5QI or QCI. + + See note.' + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + type: object + x-etsi-notes: "NOTE:\tOther identifiers could be added as needed." + x-etsi-ref: 6.5.17 + + PredictionArea: + description: 'Geographical area including the two ends of the user plane link between two V2X application instances. + + + It shall only be present when "predictionTarget" = "E2E_APPLICATION_INSTANCE_PREDICTION".' + properties: + center: + # description': Center of geographical area including the two ends of the user plane link between two V2X application instances. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': LocationInfo + $ref: '#/components/schemas/LocationInfo' + radius: + description: Radius of geographical area including the two ends of the user plane link between two V2X application instances. Measured in meters. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + required: + - center + - radius + type: object + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Structure (inlined) + + Qos: + description: Predicted QoS at the related time and vehicular UE location. Shall only be included in the response. + properties: + stream: + items: + $ref: '#/components/schemas/Stream' + type: array + required: + - stream + type: object + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Structure (inlined) + + Stream: + description: Predicted QoS at the related time and vehicular UE location for the specific data stream. In case of 3GPP network, this is mapped to a QoS flow. Stream needs to also contain the stream ID that, in case of the 3GPP network, can be mapped on to the 5QI or QCI. + minItems: 1 + properties: + qosKpi: + items: + $ref: '#/components/schemas/QosKpi' + type: array + required: + - qosKpi + type: object + x-etsi-mec-cardinality: 1..N + x-etsi-mec-origin-type: Structure (inlined) + + QosKpi: + description: This structure contains the prediction for a specific QoS KPI related to a given data stream. + minItems: 1 + properties: + confidence: + description: Confidence of the prediction, as returned by the relevant domain PF. The value and the measurement of the confidence depends on the SLA. Shall only be included in the response. + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + kpiName: + description: 'The name of the KPI (e.g. latency, UL bitrate, etc). + It can be included in the request and in the response.' + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + kpiValue: + description: 'Information on the predicted value for the specific QoS KPI. It can be in different forms, such as upper bound and lower bound, CDF, actual value, etc. + Shall only be included in the response.' + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + required: + - kpiName + - kpiValue + type: object + x-etsi-mec-cardinality: 1..N + x-etsi-mec-origin-type: Structure (inlined) + + Routes: + description: Information relating to the potential routes of a vehicular UE. Shall only be present when "predictionTarget" = "SINGLE_UE_PREDICTION". + minItems: 0 + properties: + routeInfo: + items: + $ref: '#/components/schemas/RouteInfo' + type: array + required: + - routeInfo + type: object + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: Structure (inlined) + + RouteInfo: + description: 'Information relating to a specific route. + + The first structure shall relate to the route origin and the last to the route destination. Intermediate waypoint locations may also be provided.' + minItems: 1 + properties: + location: + # description': Vehicular UE location. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': LocationInfo + $ref: '#/components/schemas/LocationInfo' + time: + # description': Estimated time at the location. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': TimeStamp + $ref: '#/components/schemas/TimeStamp' + required: + - location + type: object + x-etsi-mec-cardinality: 1..N + x-etsi-mec-origin-type: Structure (inlined) + + _links: + description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests. + properties: + self: + # description': Self-referring URI. The URI shall be unique within the VIS API as it acts as an ID for the subscription. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': LinkType + $ref: '#/components/schemas/LinkType' + required: + - self + type: object + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Structure (inlined) + + _links1: + description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests. + properties: + self: + # description': Self-referring URI. The URI shall be unique within the V2X API as it acts as an ID for the subscription. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': LinkType + $ref: '#/components/schemas/LinkType' + required: + - self + type: object + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Structure (inlined) + + _links2: + description: List of hyperlinks related to the resource. + properties: + self: + # description': URI of this resource. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': LinkType + $ref: '#/components/schemas/LinkType' + subscriptions: + items: + $ref: '#/components/schemas/Subscriptions' + type: array + required: + - self + type: object + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Structure (inlined) + + _links3: + description: Links to resources related to this notification. + properties: + subscription: + # description': A link to the related subscription. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': LinkType + $ref: '#/components/schemas/LinkType' + required: + - subscription + type: object + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Structure (inlined) + + Subscriptions: + description: The service consumer's subscriptions. + minItems: 0 + properties: + href: + description: The URI referring to the subscription. + format: uri + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uri + subscriptionType: + description: Type of the subscription. The values are as defined in the "subscriptionType" attribute for each different V2X information event subscription data type. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + required: + - href + - subscriptionType + type: object + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: Structure (inlined) + responses: '204': description: No Content diff --git a/README.md b/README.md index 8dc5edf278d228a2fde4f2b0e55c66087343e68a..e520875445a299074592d51dafe2de1bbbf5933d 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,19 @@ -# V2X Information Service API +# V2X Information Services API This repository contains OpenAPIs descriptions for the interfaces specified in ETSI GS MEC 030. ## Online resources -* [Specification document](https://www.etsi.org/deliver/etsi_gs/MEC/001_099/030/02.02.01_60/gs_MEC030v020201p.pdf) +* [Specification document](https://www.etsi.org/deliver/etsi_gs/MEC/001_099/030/03.01.01_60/gs_mec030v030101p.pdf) ## Navigate with Swagger UI -* [VIS API](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/mec/gs030-vis-api/raw/v2.2.1/MEC030_V2XInformationService.yaml) +* [VIS API](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/mec/gs030-vis-api/raw/v3.1.1/MEC030_V2XInformationServices.yaml) ## Navigate with Redocly -* [VIS API](https://redocly.github.io/redoc/?url=https://forge.etsi.org/rep/mec/gs030-vis-api/raw/v2.2.1/MEC030_V2XInformationService.yaml&nocors) +* [VIS API](https://redocly.github.io/redoc/?url=https://forge.etsi.org/rep/mec/gs030-vis-api/raw/v3.1.1/MEC030_V2XInformationServices.yaml&nocors) ## License Unless specified otherwise, the content of this repository and the files contained are released under the BSD-3-Clause license. -See the attached LICENSE file or visit https://forge.etsi.org/legal-matters. +See the attached LICENSE file or visit https://forge.etsi.org/legal-matters. \ No newline at end of file diff --git a/proto3-gen.md b/proto3-gen.md new file mode 100644 index 0000000000000000000000000000000000000000..a13581aba94e220aa41f462453f2a822a2e04cd0 --- /dev/null +++ b/proto3-gen.md @@ -0,0 +1,131 @@ +# Protobuf Schema Generation + +[OpenAPI Generator](https://openapi-generator.tech) is used to generate protobuf schema (`.proto3`) files from OpenAPI specifications of MEC030 V2X Information Services API. + +>**NOTE:** At the time of writing, the tool does not support OAS 3.1 version and we have to first convert the [V2X Information Service API](./MEC030_V2XInformationServices.yaml) to OAS 3.0 for generating protobuf schema. + +1. Convert OAS for [V2X Information Service API](./MEC030_V2XInformationServices.yaml) from 3.1 to 3.0​ + + - Change the value of `openapi` field from 3.1.0 to 3.0.0​ + + - Use this [VS code extension](https://marketplace.visualstudio.com/items?itemName=42Crunch.vscode-openapi) to see the errors in the downgraded YAML (v3.0)​ + + - Manually fix the errors​ + - mostly related to `examples` <--> `example` interchange​ + - or some 3.1 fields that are not supported in 3.0​ (comment them out) + +2. Generate proto files + - Install the `openapi-generator-cli.jar` using the installation procedure mentioned [here](https://openapi-generator.tech/docs/installation#jar). + - Generate the proto files using the following command + ```sh + $ java -jar openapi-generator-cli.jar generate -i MEC030_V2XInformationServices.yaml -g protobuf-schema -o proto3/ --package-name mec030 + ``` + +3. Carefully inspect the generated `.proto` files for any inconsistencies. Some of the things to look out for: + - Proto3 generated files for enumerations, structures containing allOf, oneOf, anyOf etc. may need to be touched manually + - Check that all the nested models are being _imported_ correctly in their parent models + - Remove redundant proto files + + +4. Validate protobuf schema by generating code from proto3 descriptions in different languages. See [this section](#code-generation-from-proto3) for more details. + +# Code Generation from proto3 + +Below are some code generation examples for Python, Go and Ruby. For other languages, please refer to https://grpc.io/docs/quickstart/. + +### Python + +1. Install the grpcio-tools package + ```sh + $ pip install grpcio-tools + ``` + +2. Create a directory for generated Python stubs + ```sh + $ mkdir python-stubs + ``` + +3. Run the following commands from the root of the directory containing this README that you are reading. + + - Models: + + ```sh + $ python -m grpc_tools.protoc -I./proto3 --python_out=./python-stubs ./proto3/models/* + ``` + + The above command will generate .py files for all the data models in the ./models directory + + - Services: + + ```sh + $ python -m grpc_tools.protoc -I./proto3 --python_out=./python-stubs --grpc_python_out=./python-stubs ./proto3/services/<*_service>.proto + ``` + + The above command will generate two files for the V2X Information Services: + - <*_servic_pb2>.py_: containing the python data models used in the service file + - <*_service_pb2_grpc>.py_: containing all the classes and functions needed for the supported HTTP methods in the service file + +### Go + +1. Install protocol buffer compiler + ```sh + $ apt install -y protobuf-compiler + ``` +2. Install Go plugins for `protoc` + ```sh + $ go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.28.1 + ``` + ```sh + $ go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.2.0 + ``` +3. Update `PATH` so `protoc` can find the plugins + ```sh + $ export PATH="$PATH:$(go env GOPATH)/bin" + ``` +4. Define a go package by appending `option go_package = "./mec030.services.v2xinformationservices";` in all .proto files like this: + + ```Go + ... + + syntax = "proto3"; + + package mec030.services.v2xinformationservices; + + option go_package = "./mec030.services.v2xinformationservices"; + + import public "models/.proto"; + + ... + ``` +5. Generate Go code for models and services + ```sh + $ mkdir go-stubs + $ protoc --go_out=./go-stubs ./proto3/models/* -I./proto3 + $ protoc --go_out=./go-stubs ./proto3/services/* --go-grpc_out=go-stubs -I./proto3 + ``` + > The generated `.pb.go` files will contain all the protocol buffer code to populate, serialize, and retrieve request and response message types defined in the `models` folder. + > And the `<*_service_grpc>.pb.go` will contain the stubs for the methods defined in the `<*_service>.proto` file. + +### Ruby + +1. Install gRPC Ruby Plugin and required tools + ```sh + $ gem install grpc + $ sudo apt install ruby-grpc-tools + ``` + +2. Generate code + ```sh + $ mkdir ruby-stubs + ``` + + Run the following command to create Ruby modules for all the data models defined in the proto files. + + ```sh + $ grpc_tools_ruby_protoc -I./proto3 --ruby_out=ruby-stubs ./proto3/models/* + ``` + Run the following command to generate `<*_service_pb>.rb` and `<*_service_services_pb>.rb` files, containing stub and service classes for the endpoints and methods defined in MEC030 V2X Information Services. + + ```sh + $ grpc_tools_ruby_protoc -I./proto3 --ruby_out=ruby-stubs --grpc_out=ruby-stubs ./proto3/services/* + ``` diff --git a/proto3/.openapi-generator-ignore b/proto3/.openapi-generator-ignore new file mode 100644 index 0000000000000000000000000000000000000000..7484ee590a3894506cf063799b885428f95a71be --- /dev/null +++ b/proto3/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# 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 diff --git a/proto3/.openapi-generator/FILES b/proto3/.openapi-generator/FILES new file mode 100644 index 0000000000000000000000000000000000000000..d7f4f39daea4114791e6e684cfe634e0149bee0c --- /dev/null +++ b/proto3/.openapi-generator/FILES @@ -0,0 +1,73 @@ +.openapi-generator-ignore +README.md +models/cell_id.proto +models/earfcn.proto +models/ecgi.proto +models/fdd_info.proto +models/info_connection.proto +models/info_protocol.proto +models/link_type.proto +models/links.proto +models/links1.proto +models/links2.proto +models/links3.proto +models/location_info.proto +models/location_info_geo_area.proto +models/msg_type.proto +models/pc5_neighbour_cell_info.proto +models/pc5_provisioning_info.proto +models/pc5_provisioning_info_pro_info_pc5.proto +models/plmn.proto +models/pred_qos_subscription.proto +models/predicted_qos.proto +models/predicted_qos_routes.proto +models/predicted_qos_routes_route_info.proto +models/prediction_area.proto +models/problem_details.proto +models/prov_chg_pc5_notification.proto +models/prov_chg_pc5_subscription.proto +models/prov_chg_pc5_subscription_filter_criteria.proto +models/prov_chg_uu_mbms_notification.proto +models/prov_chg_uu_mbms_subscription.proto +models/prov_chg_uu_mbms_subscription_filter_criteria.proto +models/prov_chg_uu_uni_notification.proto +models/prov_chg_uu_uni_subscription.proto +models/prov_chg_uu_uni_subscription_filter_criteria.proto +models/qos.proto +models/qos_kpi.proto +models/qos_pred_filter_criteria.proto +models/route_info.proto +models/routes.proto +models/stream.proto +models/subscription_link_list.proto +models/subscriptions.proto +models/tdd_info.proto +models/test_notification.proto +models/test_notification_links.proto +models/time_stamp.proto +models/transmission_bandwidth.proto +models/transmission_bandwidth_transmission_bandwidth.proto +models/uu_mbms_neighbour_cell_info.proto +models/uu_mbms_provisioning_info.proto +models/uu_mbms_provisioning_info_pro_info_uu_mbms.proto +models/uu_uni_neighbour_cell_info.proto +models/uu_unicast_provisioning_info.proto +models/uu_unicast_provisioning_info_pro_info_uu_unicast.proto +models/v2x_application_server.proto +models/v2x_msg_distribution_server.proto +models/v2x_msg_distribution_server_info.proto +models/v2x_msg_filter_criteria.proto +models/v2x_msg_notification.proto +models/v2x_msg_notification_links.proto +models/v2x_msg_properties_values.proto +models/v2x_msg_publication.proto +models/v2x_msg_subscription.proto +models/v2x_msg_subscription_filter_criteria.proto +models/v2x_server_usd.proto +models/v2x_server_usd_sdp_info.proto +models/v2x_server_usd_tmgi.proto +models/websock_notif_config.proto +services/qo_s_service.proto +services/queries_service.proto +services/subscription_service.proto +services/v2_x_msg_service.proto diff --git a/proto3/.openapi-generator/VERSION b/proto3/.openapi-generator/VERSION new file mode 100644 index 0000000000000000000000000000000000000000..1e20ec35c6422c05be73f5929fbac4c67c304fd2 --- /dev/null +++ b/proto3/.openapi-generator/VERSION @@ -0,0 +1 @@ +5.4.0 \ No newline at end of file diff --git a/proto3/README.md b/proto3/README.md new file mode 100644 index 0000000000000000000000000000000000000000..7d0ad6396833d19ed4897a47c1f91a6afcb4472d --- /dev/null +++ b/proto3/README.md @@ -0,0 +1,114 @@ +# gPRC for mec030 + +ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + +## Overview +These files were generated by the [OpenAPI Generator](https://openapi-generator.tech) project. + +- API version: 3.1.1 +- Package version: +- Build package: org.openapitools.codegen.languages.ProtobufSchemaCodegen +For more information, please visit [https://forge.etsi.org/rep/mec/gs030-vis-api](https://forge.etsi.org/rep/mec/gs030-vis-api) + +## Usage + +Below are some usage examples for Python, Go and Ruby. For other languages, please refer to https://grpc.io/docs/quickstart/. + +### Python + +1. Install the grpcio-tools package + ```sh + $ pip install grpcio-tools + ``` + +2. Create a directory for generated Python stubs + ```sh + $ mkdir python-stubs + ``` + +3. Run the following commands from the root of the directory containing this README that you are reading. + + - Models: + + ```sh + $ python -m grpc_tools.protoc -I./proto3 --python_out=./python-stubs ./proto3/models/* + ``` + + The above command will generate .py files for all the data models in the ./models directory + + - Services: + + ```sh + $ python -m grpc_tools.protoc -I./proto3 --python_out=./python-stubs --grpc_python_out=./python-stubs ./proto3/services/<*_service>.proto + ``` + + The above command will generate two files for the V2X Information Services: + - <*_servic_pb2>.py_: containing the python data models used in the service file + - <*_service_pb2_grpc>.py_: containing all the classes and functions needed for the supported HTTP methods in the service file + +### Go + +1. Install protocol buffer compiler + ```sh + $ apt install -y protobuf-compiler + ``` +2. Install Go plugins for `protoc` + ```sh + $ go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.28.1 + ``` + ```sh + $ go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.2.0 + ``` +3. Update `PATH` so `protoc` can find the plugins + ```sh + $ export PATH="$PATH:$(go env GOPATH)/bin" + ``` +4. Define a go package by appending `option go_package = "./mec030.services.v2xinformationservices";` in all .proto files like this: + + ```Go + ... + + syntax = "proto3"; + + package mec030.services.v2xinformationservices; + + option go_package = "./mec030.services.v2xinformationservices"; + + import public "models/.proto"; + + ... + ``` +5. Generate Go code for models and services + ```sh + $ mkdir go-stubs + $ protoc --go_out=./go-stubs ./proto3/models/* -I./proto3 + $ protoc --go_out=./go-stubs ./proto3/services/* --go-grpc_out=go-stubs -I./proto3 + ``` + > The generated `.pb.go` files will contain all the protocol buffer code to populate, serialize, and retrieve request and response message types defined in the `models` folder. + > And the `<*_service_grpc>.pb.go` will contain the stubs for the methods defined in the `<*_service>.proto` file. + +### Ruby + +1. Install gRPC Ruby Plugin and required tools + ```sh + $ gem install grpc + $ sudo apt install ruby-grpc-tools + ``` + +2. Generate code + ```sh + $ mkdir ruby-stubs + ``` + + Run the following command to create Ruby modules for all the data models defined in the proto files. + + ```sh + $ grpc_tools_ruby_protoc -I./proto3 --ruby_out=ruby-stubs ./proto3/models/* + ``` + Run the following command to generate `<*_service_pb>.rb` and `<*_service_services_pb>.rb` files, containing stub and service classes for the endpoints and methods defined in MEC030 V2X Information Services. + + ```sh + $ grpc_tools_ruby_protoc -I./proto3 --ruby_out=ruby-stubs --grpc_out=ruby-stubs ./proto3/services/* + ``` + +``` \ No newline at end of file diff --git a/proto3/models/cell_id.proto b/proto3/models/cell_id.proto index d88d637f65d51e420e307b5040517d716ada8bb8..dfc1d96e11800c1f20aa8307be8acbdbf0e00746 100644 --- a/proto3/models/cell_id.proto +++ b/proto3/models/cell_id.proto @@ -1,10 +1,12 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ @@ -16,6 +18,6 @@ package mec030; message CellId { // E-UTRAN Cell Identity as a bit string (size (28)). - string cell_id = 1; + string cellId = 1; } diff --git a/proto3/models/earfcn.proto b/proto3/models/earfcn.proto index 762f84c5a1141d29ba2695f0904e49b1ad5d3a69..e6e2f97a7e63af7bbfe0c295566ed9d3a9e58930 100644 --- a/proto3/models/earfcn.proto +++ b/proto3/models/earfcn.proto @@ -1,10 +1,12 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ @@ -16,6 +18,6 @@ package mec030; message Earfcn { // E-UTRA Absolute Radio Frequency Channel Number, range (0... 65535) - int32 earfcn = 1; + int32 earfcn = 2; } diff --git a/proto3/models/ecgi.proto b/proto3/models/ecgi.proto index c4bb5b4fd98bc2522ef4b7fcdd822cb04af6da7f..ca8f8c142a96e0821eb1c13857329b46e9d3e026 100644 --- a/proto3/models/ecgi.proto +++ b/proto3/models/ecgi.proto @@ -1,10 +1,12 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ @@ -17,7 +19,7 @@ import public "models/plmn.proto"; message Ecgi { - CellId cell_id = 1; + CellId cellId = 1; Plmn plmn = 2; diff --git a/proto3/models/fdd_info.proto b/proto3/models/fdd_info.proto index a4121928c5beb388704f66ebd987d7f86f3c61f8..e73fe1b1cba0c93bcb39390b515f020b89800a2d 100644 --- a/proto3/models/fdd_info.proto +++ b/proto3/models/fdd_info.proto @@ -1,10 +1,12 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ @@ -17,12 +19,12 @@ import public "models/transmission_bandwidth.proto"; message FddInfo { - Earfcn dl_earfcn = 1; + Earfcn dlEarfcn = 1; - TransmissionBandwidth dl_transmission_bandwidth = 2; + TransmissionBandwidth dlTransmissionBandwidth = 2; - Earfcn ul_earfcn = 3; + Earfcn ulEarfcn = 3; - TransmissionBandwidth ul_transmission_bandwidth = 4; + TransmissionBandwidth ulTransmissionBandwidth = 4; } diff --git a/proto3/models/info_connection.proto b/proto3/models/info_connection.proto new file mode 100644 index 0000000000000000000000000000000000000000..c1e9c9c4ad75d3d6f9a17bc13c3d3bf22d87d279 --- /dev/null +++ b/proto3/models/info_connection.proto @@ -0,0 +1,26 @@ +/* + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + + Contact: cti_support@etsi.org + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec030; + + +message InfoConnection { + + // IP address of the V2X Message Distribution Server. + string ipAddress = 1; + + // Port number of the V2X Message Distribution Server. + int32 port_number = 2; + +} diff --git a/proto3/models/info_protocol.proto b/proto3/models/info_protocol.proto new file mode 100644 index 0000000000000000000000000000000000000000..bf78c9faaf8e02f2cb37c9889915ecbd7d4a03d7 --- /dev/null +++ b/proto3/models/info_protocol.proto @@ -0,0 +1,34 @@ +/* + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + + Contact: cti_support@etsi.org + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec030; + + +message InfoProtocol { + + // Numerical value corresponding to the application layer protocol supported by the service consumer. For the msgProtocol, the following values are currently defined (see note): 0 = MQTT v3.1.0 1 = MQTT v3.1.1 2 = MQTT v5 3 = MQTT-SN 4 = AMQP 1.0 + enum MsgProtocolEnum { + _0 = 0; + _1 = 1; + _2 = 2; + _3 = 3; + _4 = 4; + } + + MsgProtocolEnum msgProtocol = 1; + + // Implementation specifics of application layer protocol, e.g. programming language. + string protImplementation = 2; + +} diff --git a/proto3/models/link_type.proto b/proto3/models/link_type.proto index 92f2ce888bd3bc05283e6dfc3437dbb21a5e0218..30cb9fb234b02881a36efbabfe7fe8b18d5393e5 100644 --- a/proto3/models/link_type.proto +++ b/proto3/models/link_type.proto @@ -1,10 +1,12 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ @@ -15,7 +17,7 @@ package mec030; message LinkType { - // The URI referring to the subscription. + // URI referring to a resource string href = 1; } diff --git a/proto3/models/prov_chg_pc5_subscription_links.proto b/proto3/models/links.proto similarity index 50% rename from proto3/models/prov_chg_pc5_subscription_links.proto rename to proto3/models/links.proto index 8a4ec4ea34671a12017f1ca81ec5e8cdaa465bc4..b7d9aa5fe776094b82999b8c36b2bf44ce66a11b 100644 --- a/proto3/models/prov_chg_pc5_subscription_links.proto +++ b/proto3/models/links.proto @@ -1,10 +1,12 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ @@ -14,7 +16,7 @@ package mec030; import public "models/link_type.proto"; -message ProvChgPc5SubscriptionLinks { +message Links { LinkType self = 1; diff --git a/proto3/models/prov_chg_uu_uni_subscription_links.proto b/proto3/models/links1.proto similarity index 50% rename from proto3/models/prov_chg_uu_uni_subscription_links.proto rename to proto3/models/links1.proto index e2a26bfdf4083807d4c9119b1b0f2c70ff54d01d..95b6a84d4fd37b86991e686e22c02853650a95b0 100644 --- a/proto3/models/prov_chg_uu_uni_subscription_links.proto +++ b/proto3/models/links1.proto @@ -1,10 +1,12 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ @@ -14,7 +16,7 @@ package mec030; import public "models/link_type.proto"; -message ProvChgUuUniSubscriptionLinks { +message Links1 { LinkType self = 1; diff --git a/proto3/models/links2.proto b/proto3/models/links2.proto new file mode 100644 index 0000000000000000000000000000000000000000..4f2ea4d48ae087df864270b8e92d3969df939e88 --- /dev/null +++ b/proto3/models/links2.proto @@ -0,0 +1,26 @@ +/* + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + + Contact: cti_support@etsi.org + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec030; + +import public "models/link_type.proto"; +import public "models/subscriptions.proto"; + +message Links2 { + + LinkType self = 1; + + repeated Subscriptions subscriptions = 2; + +} diff --git a/proto3/models/links3.proto b/proto3/models/links3.proto new file mode 100644 index 0000000000000000000000000000000000000000..bcdf56a8c876c1187f1d4a09a2468565f1c69c5d --- /dev/null +++ b/proto3/models/links3.proto @@ -0,0 +1,23 @@ +/* + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + + Contact: cti_support@etsi.org + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec030; + +import public "models/link_type.proto"; + +message Links3 { + + LinkType subscription = 1; + +} diff --git a/proto3/models/location_info.proto b/proto3/models/location_info.proto index 7abcc22b6c1c28d7fd098aaa0319ae3090292e28..d6638e5219fbee2775fdb78a92752113833334ce 100644 --- a/proto3/models/location_info.proto +++ b/proto3/models/location_info.proto @@ -1,10 +1,12 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ @@ -19,6 +21,6 @@ message LocationInfo { Ecgi ecgi = 1; - LocationInfoGeoArea geo_area = 2; + LocationInfoGeoArea geoArea = 2; } diff --git a/proto3/models/location_info_geo_area.proto b/proto3/models/location_info_geo_area.proto index 3c462ebf73b86b3a5e6037833f2c97684e5b8d0e..4f6f14c4d7bc83215dab6f545d71a7a596960059 100644 --- a/proto3/models/location_info_geo_area.proto +++ b/proto3/models/location_info_geo_area.proto @@ -1,10 +1,12 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ @@ -18,7 +20,7 @@ message LocationInfoGeoArea { // Latitude (DATUM = WGS84) -90 to 90 in decimal degree format DDD.ddd float latitude = 1; - // Longitude (DATUM = WGS84)-180 to 180 in decimal degree format DDD.ddd + // Longitude (DATUM = WGS84) -180 to 180 in decimal degree format DDD.ddd float longitude = 2; } diff --git a/proto3/models/msg_type.proto b/proto3/models/msg_type.proto index 2eacd7a68178ed6e270ec822b14fe9552a4585fa..17be29adf2f7adda6960f1fa9975363ee917016d 100644 --- a/proto3/models/msg_type.proto +++ b/proto3/models/msg_type.proto @@ -1,10 +1,12 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ @@ -13,15 +15,18 @@ syntax = "proto3"; package mec030; -message MsgType { -enum TypeEnum { - MSG_TYPE_TYPE_ENUM_1 = 0; - MSG_TYPE_TYPE_ENUM_2 = 1; - MSG_TYPE_TYPE_ENUM_3 = 2; - MSG_TYPE_TYPE_ENUM_4 = 3; - MSG_TYPE_TYPE_ENUM_5 = 4; - MSG_TYPE_TYPE_ENUM_6 = 5; - MSG_TYPE_TYPE_ENUM_7 = 6; - } +enum MsgType { + denm = 0; + cam = 1; + poi = 2; + spatem = 3; + mapem = 4; + ivim = 5; + ev_rsr = 6; + tistpgtransaction = 7; + srem = 8; + ssem = 9; + evcsn = 10; + saem = 11; + rtcmem = 12; } - diff --git a/proto3/models/pc5_neighbour_cell_info.proto b/proto3/models/pc5_neighbour_cell_info.proto index c6415500929e775368cec60934bf008503e37282..f7876c5aa250c9694b1281bfc5154d76f2d08efa 100644 --- a/proto3/models/pc5_neighbour_cell_info.proto +++ b/proto3/models/pc5_neighbour_cell_info.proto @@ -1,10 +1,12 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ @@ -21,7 +23,6 @@ message Pc5NeighbourCellInfo { Plmn plmn = 2; - // V2X sidelink communication configuration, as defined in ETSI TS 136 331 [i.11]. - string si_v2x_config = 3; + string siV2xConfig = 3; } diff --git a/proto3/models/pc5_provisioning_info.proto b/proto3/models/pc5_provisioning_info.proto index ec7305439ee5752df0af6ead6cd78abe1b5fba41..64f96c3c517e4396c4862bebdba9dd4a4b2186e6 100644 --- a/proto3/models/pc5_provisioning_info.proto +++ b/proto3/models/pc5_provisioning_info.proto @@ -1,10 +1,12 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ @@ -17,8 +19,8 @@ import public "models/time_stamp.proto"; message Pc5ProvisioningInfo { - repeated Pc5ProvisioningInfoProInfoPc5 pro_info_pc5 = 1; + repeated Pc5ProvisioningInfoProInfoPc5 proInfoPc5 = 1; - TimeStamp time_stamp = 2; + TimeStamp timeStamp = 2; } diff --git a/proto3/models/pc5_provisioning_info_pro_info_pc5.proto b/proto3/models/pc5_provisioning_info_pro_info_pc5.proto index 5f18e72a0d9152cd39739aadcc1dc30c39adccfb..043cb469b538cdf8532060113c4f3c1c50f96045 100644 --- a/proto3/models/pc5_provisioning_info_pro_info_pc5.proto +++ b/proto3/models/pc5_provisioning_info_pro_info_pc5.proto @@ -1,10 +1,12 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ @@ -17,12 +19,12 @@ import public "models/pc5_neighbour_cell_info.proto"; message Pc5ProvisioningInfoProInfoPc5 { - // For sidelink communication, the Destination Layer-2 ID is set to the ProSe Layer-2 Group ID or Prose UE ID, see ETSI TS 136 321 [i.12]. PLMN operators coordinate to make sure Destination Layer-2 ID(s) for different V2X services are configured in a consistent manner. - string dst_layer2_id = 1; + // For sidelink communication, the Destination Layer-2 ID is set to the ProSe Layer-2 Group ID or Prose UE ID, see ETSI TS 136 321 [i.12]. PLMN operators coordinate to make sure Destination Layer2 ID(s) for different V2X services are configured in a consistent manner. + string dstLayer2Id = 1; - LocationInfo location_info = 2; + LocationInfo locationInfo = 2; // The information of the neighbour cells in a visiting PLMN that support V2X communication over PC5. - repeated Pc5NeighbourCellInfo neighbour_cell_info = 3; + repeated Pc5NeighbourCellInfo neighbourCellInfo = 3; } diff --git a/proto3/models/plmn.proto b/proto3/models/plmn.proto index fd962dd502ae8f75ab5651e83a35bc49b5ef0dd0..375dd4bfdace6c32aeb1d79c51cc920d0710e5ac 100644 --- a/proto3/models/plmn.proto +++ b/proto3/models/plmn.proto @@ -1,10 +1,12 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ diff --git a/proto3/models/pred_qos_subscription.proto b/proto3/models/pred_qos_subscription.proto new file mode 100644 index 0000000000000000000000000000000000000000..3d5a35ab48385dc61997e02836ccb5154389b191 --- /dev/null +++ b/proto3/models/pred_qos_subscription.proto @@ -0,0 +1,41 @@ +/* + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + + Contact: cti_support@etsi.org + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec030; + +import public "models/links1.proto"; +import public "models/qos_pred_filter_criteria.proto"; +import public "models/time_stamp.proto"; +import public "models/websock_notif_config.proto"; + +message PredQosSubscription { + + Links1 _links = 1; + + // URI exposed by the client on which to receive notifications via HTTP. See note. + string callbackReference = 2; + + TimeStamp expiryDeadline = 3; + + QosPredFilterCriteria filterCriteria = 4; + + // Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as described in ETSI GS MEC 009 [9], clause 6.12a. Default: FALSE. + bool requestTestNotification = 5; + + // Shall be set to \"PredQosSubscription\". + string subscriptionType = 6; + + WebsockNotifConfig websockNotifConfig = 7; + +} diff --git a/proto3/models/predicted_qos.proto b/proto3/models/predicted_qos.proto index 42b70a766df42982e2abc49a6793f81d25536c62..1b763eaf59ceb4a127531e676eef9f009ab6c5b9 100644 --- a/proto3/models/predicted_qos.proto +++ b/proto3/models/predicted_qos.proto @@ -1,10 +1,12 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ @@ -12,16 +14,31 @@ syntax = "proto3"; package mec030; -import public "models/predicted_qos_routes.proto"; +import public "models/prediction_area.proto"; +import public "models/qos.proto"; +import public "models/routes.proto"; import public "models/time_stamp.proto"; message PredictedQos { - TimeStamp time_granularity = 1; + // Granularity of visited location. Measured in meters. + string locationGranularity = 1; + + TimeStamp noticePeriod = 2; + + PredictionArea predictionArea = 3; + + // Indicates target of QoS prediction. Valid values: 1. SINGLE_UE_PREDICTION: The predicted QoS is to be intended as journey-specific for a requesting vehicular UE. 2. E2E_APPLICATION_INSTANCE_PREDICTION: The E2E user plane link between two V2X application instances, where one instance relates to a single vehicular UE and the other instance to an application instance within another network, i.e. either another vehicular UE as in the V2N2V case, or an infrastructure element as in the V2N2I case. Shall only be included in the request. + enum PredictionTargetEnum { + SEE_DESCRIPTION = 0; + } + + PredictionTargetEnum predictionTarget = 4; + + Qos qos = 5; - // Granularity of visited location. Measured in meters - string location_granularity = 2; + repeated Routes routes = 6; - repeated PredictedQosRoutes routes = 3; + TimeStamp timeGranularity = 7; } diff --git a/proto3/models/predicted_qos_routes.proto b/proto3/models/predicted_qos_routes.proto index 0e8e04a97ca999c4d3efeb982fd12adbf098a7d1..cee84db2c149d301ccdf4ae8f8b8441d24ad912c 100644 --- a/proto3/models/predicted_qos_routes.proto +++ b/proto3/models/predicted_qos_routes.proto @@ -1,10 +1,12 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ @@ -16,7 +18,7 @@ import public "models/predicted_qos_routes_route_info.proto"; message PredictedQosRoutes { - // Information relating to a specific route. The first structure shall relate to the route origin and the last to the route destination. Intermediate waypoint locations may also be provided. - repeated PredictedQosRoutesRouteInfo routeinfo = 1; + // Information relating to a specific route. The first structure shall relate to the route origin and the last to the route destination. Intermediate waypoint locations may also be provided. + repeated PredictedQosRoutesRouteInfo routeInfo = 1; } diff --git a/proto3/models/predicted_qos_routes_route_info.proto b/proto3/models/predicted_qos_routes_route_info.proto index db2d6006d174ceefc477c9516db328744ed05e31..06021ef6534d7c672509bbe84b6ba9376551adbf 100644 --- a/proto3/models/predicted_qos_routes_route_info.proto +++ b/proto3/models/predicted_qos_routes_route_info.proto @@ -1,10 +1,12 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ @@ -19,12 +21,12 @@ message PredictedQosRoutesRouteInfo { LocationInfo location = 1; - TimeStamp time = 2; + // Reference Signal Received Power as defined in ETSI TS 136 214 [i.13]. Shall only be included in the response. + int32 rsrp = 2; - // Reference Signal Received Quality as defined in ETSI TS 136 214 [i.13]. Shall only be included in the response - int32 rsrp = 3; + // Reference Signal Received Quality as defined in ETSI TS 136 214 [i.13]. Shall only be included in the response. + int32 rsrq = 3; - // Reference Signal Received Quality as defined in ETSI TS 136 214 [i.13]. Shall only be included in the response - int32 rsrq = 4; + TimeStamp time = 4; } diff --git a/proto3/models/prediction_area.proto b/proto3/models/prediction_area.proto new file mode 100644 index 0000000000000000000000000000000000000000..2754477f3bee45f08cab43d720236a4ecde0d68d --- /dev/null +++ b/proto3/models/prediction_area.proto @@ -0,0 +1,26 @@ +/* + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + + Contact: cti_support@etsi.org + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec030; + +import public "models/location_info.proto"; + +message PredictionArea { + + LocationInfo center = 1; + + // Radius of geographical area including the two ends of the user plane link between two V2X application instances. Measured in meters. + string radius = 2; + +} diff --git a/proto3/models/problem_details.proto b/proto3/models/problem_details.proto index 08e0b55fcbe8d2d5f29225a0615294f512fa7771..c9942c188180c7a234c92c9c72796c4f2ac5f5b0 100644 --- a/proto3/models/problem_details.proto +++ b/proto3/models/problem_details.proto @@ -1,10 +1,12 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ diff --git a/proto3/models/prov_chg_pc5_notification.proto b/proto3/models/prov_chg_pc5_notification.proto index 4000862b9532f13bc21e07af328373007fe86ce2..dc07a588d901c41aacd4d48a20eb647e5ce7c80a 100644 --- a/proto3/models/prov_chg_pc5_notification.proto +++ b/proto3/models/prov_chg_pc5_notification.proto @@ -1,10 +1,12 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ @@ -19,16 +21,16 @@ import public "models/time_stamp.proto"; message ProvChgPc5Notification { // For sidelink communication, the Destination Layer-2 ID is set to the ProSe Layer-2 Group ID or Prose UE ID, see ETSI TS 136 321 [i.12]. - string dst_layer2_id = 1; + string dstLayer2Id = 1; - LocationInfo location_info = 2; + LocationInfo locationInfo = 2; // The information of the neighbour cells in a visiting PLMN that support V2X communication over PC5. - repeated Pc5NeighbourCellInfo neighbour_cell_info = 3; + repeated Pc5NeighbourCellInfo neighbourCellInfo = 3; // Shall be set to \"ProvChgPc5Notification\". - string notification_type = 4; + string notificationType = 4; - TimeStamp time_stamp = 5; + TimeStamp timeStamp = 5; } diff --git a/proto3/models/prov_chg_pc5_subscription.proto b/proto3/models/prov_chg_pc5_subscription.proto index 1398a0e06a9119f3ae9d41e1ed4df811d605e242..3a36fade0870dd72086c46f78328b216b14d0028 100644 --- a/proto3/models/prov_chg_pc5_subscription.proto +++ b/proto3/models/prov_chg_pc5_subscription.proto @@ -1,10 +1,12 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ @@ -12,22 +14,28 @@ syntax = "proto3"; package mec030; +import public "models/links.proto"; import public "models/prov_chg_pc5_subscription_filter_criteria.proto"; -import public "models/prov_chg_pc5_subscription_links.proto"; import public "models/time_stamp.proto"; +import public "models/websock_notif_config.proto"; message ProvChgPc5Subscription { - ProvChgPc5SubscriptionLinks links = 1; + Links _links = 1; + + // URI exposed by the client on which to receive notifications via HTTP. See note. + string callbackReference = 2; - // URI selected by the service consumer to receive notifications on the subscribed VIS information. This shall be included both in the request and in response. - string callback_reference = 2; + TimeStamp expiryDeadline = 3; - TimeStamp expiry_deadline = 3; + ProvChgPc5SubscriptionFilterCriteria filterCriteria = 4; - ProvChgPc5SubscriptionFilterCriteria filter_criteria = 4; + // Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as described in ETSI GS MEC 009 [i.1], clause 6.12a. Default: FALSE. + bool requestTestNotification = 5; // Shall be set to \"ProvChgPc5Subscription\". - string subscription_type = 5; + string subscriptionType = 6; + + WebsockNotifConfig websockNotifConfig = 7; } diff --git a/proto3/models/prov_chg_pc5_subscription_filter_criteria.proto b/proto3/models/prov_chg_pc5_subscription_filter_criteria.proto index c52ad514feb5a1ea059cea6e8fe3c16fd961fba5..ec28592211cec3235255357f217285f02e23e710 100644 --- a/proto3/models/prov_chg_pc5_subscription_filter_criteria.proto +++ b/proto3/models/prov_chg_pc5_subscription_filter_criteria.proto @@ -1,10 +1,12 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ @@ -18,11 +20,11 @@ import public "models/pc5_neighbour_cell_info.proto"; message ProvChgPc5SubscriptionFilterCriteria { // For sidelink communication, the Destination Layer-2 ID is set to the ProSe Layer-2 Group ID or Prose UE ID, see ETSI TS 136 321 [i.12]. - string dst_layer2_id = 1; + string dstLayer2Id = 1; - LocationInfo location_info = 2; + LocationInfo locationInfo = 2; // The information of the neighbour cells in a visiting PLMN that support V2X communication over PC5. - repeated Pc5NeighbourCellInfo neighbour_cell_info = 3; + repeated Pc5NeighbourCellInfo neighbourCellInfo = 3; } diff --git a/proto3/models/prov_chg_uu_mbms_notification.proto b/proto3/models/prov_chg_uu_mbms_notification.proto index f01e1d3128d9c8f3a97d96dc56fd28205b53f231..4fb0ae923a68cf52e90476679523c0f9406d174e 100644 --- a/proto3/models/prov_chg_uu_mbms_notification.proto +++ b/proto3/models/prov_chg_uu_mbms_notification.proto @@ -1,10 +1,12 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ @@ -19,16 +21,16 @@ import public "models/v2x_server_usd.proto"; message ProvChgUuMbmsNotification { - LocationInfo location_info = 1; + LocationInfo locationInfo = 1; // The information of the neighbour cells in a visiting PLMN that support V2X communication over Uu MBMS. - repeated UuMbmsNeighbourCellInfo neighbour_cell_info = 2; + repeated UuMbmsNeighbourCellInfo neighbourCellInfo = 2; // Shall be set to \"ProvChgUuMbmsNotification\". - string notification_type = 3; + string notificationType = 3; - TimeStamp time_stamp = 4; + TimeStamp timeStamp = 4; - V2xServerUsd v2x_server_usd = 5; + V2xServerUsd v2xServerUsd = 5; } diff --git a/proto3/models/prov_chg_uu_mbms_subscription.proto b/proto3/models/prov_chg_uu_mbms_subscription.proto index a0f802d8702ba7f1df6c84ef313c973e43e417c6..b4dd0586577cddc80eef44cdea76288c6b1c516b 100644 --- a/proto3/models/prov_chg_uu_mbms_subscription.proto +++ b/proto3/models/prov_chg_uu_mbms_subscription.proto @@ -1,10 +1,12 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ @@ -12,22 +14,28 @@ syntax = "proto3"; package mec030; +import public "models/links.proto"; import public "models/prov_chg_uu_mbms_subscription_filter_criteria.proto"; -import public "models/prov_chg_uu_mbms_subscription_links.proto"; import public "models/time_stamp.proto"; +import public "models/websock_notif_config.proto"; message ProvChgUuMbmsSubscription { - ProvChgUuMbmsSubscriptionLinks links = 1; + Links _links = 1; + + // URI exposed by the client on which to receive notifications via HTTP. See note. + string callbackReference = 2; - // URI selected by the service consumer to receive notifications on the subscribed VIS information. This shall be included both in the request and in response. - string callback_reference = 2; + TimeStamp expiryDeadline = 3; - TimeStamp expiry_deadline = 3; + ProvChgUuMbmsSubscriptionFilterCriteria filterCriteria = 4; - ProvChgUuMbmsSubscriptionFilterCriteria filter_criteria = 4; + // Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as described in ETSI GS MEC 009 [i.1], clause 6.12a. Default: FALSE. + bool requestTestNotification = 5; // Shall be set to \"ProvChgUuMbmsSubscription\". - string subscription_type = 5; + string subscriptionType = 6; + + WebsockNotifConfig websockNotifConfig = 7; } diff --git a/proto3/models/prov_chg_uu_mbms_subscription_filter_criteria.proto b/proto3/models/prov_chg_uu_mbms_subscription_filter_criteria.proto index be3939fae04f77d8b9183e633ae75ef9e2286e01..627d8bed8fb6c7a98a3c2442799e22f0df9e190f 100644 --- a/proto3/models/prov_chg_uu_mbms_subscription_filter_criteria.proto +++ b/proto3/models/prov_chg_uu_mbms_subscription_filter_criteria.proto @@ -1,10 +1,12 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ @@ -18,11 +20,11 @@ import public "models/v2x_server_usd.proto"; message ProvChgUuMbmsSubscriptionFilterCriteria { - LocationInfo location_info = 1; + LocationInfo locationInfo = 1; // The information of the neighbour cells in a visiting PLMN that support V2X communication over Uu MBMS. - repeated UuMbmsNeighbourCellInfo neighbour_cell_info = 2; + repeated UuMbmsNeighbourCellInfo neighbourCellInfo = 2; - V2xServerUsd v2x_server_usd = 3; + V2xServerUsd v2xServerUsd = 3; } diff --git a/proto3/models/prov_chg_uu_mbms_subscription_links.proto b/proto3/models/prov_chg_uu_mbms_subscription_links.proto deleted file mode 100644 index e51e52387184d9be401886bf68084f1fcc32e308..0000000000000000000000000000000000000000 --- a/proto3/models/prov_chg_uu_mbms_subscription_links.proto +++ /dev/null @@ -1,21 +0,0 @@ -/* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 - Contact: cti_support@etsi.org - Generated by OpenAPI Generator: https://openapi-generator.tech -*/ - -syntax = "proto3"; - -package mec030; - -import public "models/link_type.proto"; - -message ProvChgUuMbmsSubscriptionLinks { - - LinkType self = 1; - -} diff --git a/proto3/models/prov_chg_uu_uni_notification.proto b/proto3/models/prov_chg_uu_uni_notification.proto index 088e9756f81c0b361bc88438f6f721caf0c566ce..2024812211379a0db7f070c277a2bcc18f1b1777 100644 --- a/proto3/models/prov_chg_uu_uni_notification.proto +++ b/proto3/models/prov_chg_uu_uni_notification.proto @@ -1,10 +1,12 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ @@ -19,16 +21,16 @@ import public "models/v2x_application_server.proto"; message ProvChgUuUniNotification { - LocationInfo location_info = 1; + LocationInfo locationInfo = 1; // The information of the neighbour cells in a visiting PLMN that support V2X communication over Uu unicast. - repeated UuUniNeighbourCellInfo neighbour_cell_info = 2; + repeated UuUniNeighbourCellInfo neighbourCellInfo = 2; // Shall be set to \"ProvChgUuUniNotification\". - string notification_type = 3; + string notificationType = 3; - TimeStamp time_stamp = 4; + TimeStamp timeStamp = 4; - V2xApplicationServer v2x_application_server = 5; + V2xApplicationServer v2xApplicationServer = 5; } diff --git a/proto3/models/prov_chg_uu_uni_subscription.proto b/proto3/models/prov_chg_uu_uni_subscription.proto index 3b9eed02254064fc020d379cb8e03e7cb0e249a7..6d23f40a4aa5842cd1084ace5e89ef42c5d0548b 100644 --- a/proto3/models/prov_chg_uu_uni_subscription.proto +++ b/proto3/models/prov_chg_uu_uni_subscription.proto @@ -1,10 +1,12 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ @@ -12,22 +14,28 @@ syntax = "proto3"; package mec030; +import public "models/links.proto"; import public "models/prov_chg_uu_uni_subscription_filter_criteria.proto"; -import public "models/prov_chg_uu_uni_subscription_links.proto"; import public "models/time_stamp.proto"; +import public "models/websock_notif_config.proto"; message ProvChgUuUniSubscription { - ProvChgUuUniSubscriptionLinks links = 1; + Links _links = 1; + + // URI exposed by the client on which to receive notifications via HTTP. See note. + string callbackReference = 2; - // URI selected by the service consumer to receive notifications on the subscribed VIS information. This shall be included both in the request and in response. - string callback_reference = 2; + TimeStamp expiryDeadline = 3; - TimeStamp expiry_deadline = 3; + ProvChgUuUniSubscriptionFilterCriteria filterCriteria = 4; - ProvChgUuUniSubscriptionFilterCriteria filter_criteria = 4; + // Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as described in ETSI GS MEC 009 [i.1], clause 6.12a. Default: FALSE. + bool requestTestNotification = 5; // Shall be set to \"ProvChgUuUniSubscription\". - string subscription_type = 5; + string subscriptionType = 6; + + WebsockNotifConfig websockNotifConfig = 7; } diff --git a/proto3/models/prov_chg_uu_uni_subscription_filter_criteria.proto b/proto3/models/prov_chg_uu_uni_subscription_filter_criteria.proto index 7a7918e2c25ea3378c2cd745f18fe3d5b1be996b..69fdac01344507c1f6939f97eb0be3215a23da33 100644 --- a/proto3/models/prov_chg_uu_uni_subscription_filter_criteria.proto +++ b/proto3/models/prov_chg_uu_uni_subscription_filter_criteria.proto @@ -1,10 +1,12 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ @@ -18,11 +20,11 @@ import public "models/v2x_application_server.proto"; message ProvChgUuUniSubscriptionFilterCriteria { - LocationInfo location_info = 1; + LocationInfo locationInfo = 1; // The information of the neighbour cells in a visiting PLMN that support V2X communication over Uu unicast. - repeated UuUniNeighbourCellInfo neighbour_cell_info = 2; + repeated UuUniNeighbourCellInfo neighbourCellInfo = 2; - V2xApplicationServer v2x_application_server = 3; + V2xApplicationServer v2xApplicationServer = 3; } diff --git a/proto3/models/qos.proto b/proto3/models/qos.proto new file mode 100644 index 0000000000000000000000000000000000000000..75a605d13a9746d208ba2dec9ed2645773c275ee --- /dev/null +++ b/proto3/models/qos.proto @@ -0,0 +1,23 @@ +/* + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + + Contact: cti_support@etsi.org + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec030; + +import public "models/stream.proto"; + +message Qos { + + repeated Stream stream = 1; + +} diff --git a/proto3/models/qos_kpi.proto b/proto3/models/qos_kpi.proto new file mode 100644 index 0000000000000000000000000000000000000000..5bd238ef6cfb8be3a29a0745444a661d8cc014da --- /dev/null +++ b/proto3/models/qos_kpi.proto @@ -0,0 +1,29 @@ +/* + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + + Contact: cti_support@etsi.org + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec030; + + +message QosKpi { + + // Confidence of the prediction, as returned by the relevant domain PF. The value and the measurement of the confidence depends on the SLA. Shall only be included in the response. + string confidence = 1; + + // The name of the KPI (e.g. latency, UL bitrate, etc). It can be included in the request and in the response. + string kpiName = 2; + + // Information on the predicted value for the specific QoS KPI. It can be in different forms, such as upper bound and lower bound, CDF, actual value, etc. Shall only be included in the response. + string kpiValue = 3; + +} diff --git a/proto3/models/qos_pred_filter_criteria.proto b/proto3/models/qos_pred_filter_criteria.proto new file mode 100644 index 0000000000000000000000000000000000000000..ca12335bd452f9169b382665117fd22acb6ef347 --- /dev/null +++ b/proto3/models/qos_pred_filter_criteria.proto @@ -0,0 +1,23 @@ +/* + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + + Contact: cti_support@etsi.org + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec030; + + +message QosPredFilterCriteria { + + // The predicted QoS at the related time and vehicular UE location is provided for a specific data stream. In case of 3GPP network, this is mapped to a QoS flow. Stream needs to also contain the stream ID which, in case of the 3GPP network, can be mapped on to the 5QI or QCI. See note. + string streamId = 1; + +} diff --git a/proto3/models/route_info.proto b/proto3/models/route_info.proto new file mode 100644 index 0000000000000000000000000000000000000000..6d1cb62143d9e106e636363b2b657d3b8c90f6c5 --- /dev/null +++ b/proto3/models/route_info.proto @@ -0,0 +1,26 @@ +/* + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + + Contact: cti_support@etsi.org + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec030; + +import public "models/location_info.proto"; +import public "models/time_stamp.proto"; + +message RouteInfo { + + LocationInfo location = 1; + + TimeStamp time = 2; + +} diff --git a/proto3/models/routes.proto b/proto3/models/routes.proto new file mode 100644 index 0000000000000000000000000000000000000000..920a0a0b67896d5a3c7a62e808de0e51d4bdc17a --- /dev/null +++ b/proto3/models/routes.proto @@ -0,0 +1,23 @@ +/* + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + + Contact: cti_support@etsi.org + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec030; + +import public "models/route_info.proto"; + +message Routes { + + repeated RouteInfo routeInfo = 1; + +} diff --git a/proto3/models/stream.proto b/proto3/models/stream.proto new file mode 100644 index 0000000000000000000000000000000000000000..5f8717f69b1f5ef17efe4d390189f2445a68e097 --- /dev/null +++ b/proto3/models/stream.proto @@ -0,0 +1,23 @@ +/* + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + + Contact: cti_support@etsi.org + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec030; + +import public "models/qos_kpi.proto"; + +message Stream { + + repeated QosKpi qosKpi = 1; + +} diff --git a/proto3/models/subscription.proto b/proto3/models/subscription.proto index fe35039ecab589deb2038831e18a5c7369f32181..29a8d80ebbd4febe62758f0a7d2ef3b64e9663d6 100644 --- a/proto3/models/subscription.proto +++ b/proto3/models/subscription.proto @@ -1,10 +1,12 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ @@ -16,6 +18,7 @@ import public "models/prov_chg_uu_uni_subscription.proto"; import public "models/prov_chg_uu_mbms_subscription.proto"; import public "models/prov_chg_pc5_subscription.proto"; import public "models/v2x_msg_subscription.proto"; +import public "models/pred_qos_subscription.proto"; message Subscription { oneof subscription { @@ -23,5 +26,6 @@ message Subscription { ProvChgUuMbmsSubscription prov_chg_uu_mbms_subscription = 2; ProvChgPc5Subscription prov_chg_pc5_subscription = 3; V2xMsgSubscription v2x_msg_subscription = 4; + PredQosSubscription pred_qos_subscription = 5; } -} +} \ No newline at end of file diff --git a/proto3/models/subscription_link_list.proto b/proto3/models/subscription_link_list.proto index 11714370521b9ab91c1407531d37309809b71bde..e0a709483f9622e834e36d7dd99e6f3412c13fab 100644 --- a/proto3/models/subscription_link_list.proto +++ b/proto3/models/subscription_link_list.proto @@ -1,10 +1,12 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ @@ -12,10 +14,10 @@ syntax = "proto3"; package mec030; -import public "models/subscription_link_list_links.proto"; +import public "models/links2.proto"; message SubscriptionLinkList { - SubscriptionLinkListLinks links = 1; + Links2 _links = 1; } diff --git a/proto3/models/subscription_link_list_links.proto b/proto3/models/subscription_link_list_links.proto deleted file mode 100644 index de49d73dea9854895f0189db601d0946341548ca..0000000000000000000000000000000000000000 --- a/proto3/models/subscription_link_list_links.proto +++ /dev/null @@ -1,24 +0,0 @@ -/* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 - Contact: cti_support@etsi.org - Generated by OpenAPI Generator: https://openapi-generator.tech -*/ - -syntax = "proto3"; - -package mec030; - -import public "models/link_type.proto"; -import public "models/subscription_link_list_links_subscriptions.proto"; - -message SubscriptionLinkListLinks { - - LinkType self = 1; - - repeated SubscriptionLinkListLinksSubscriptions subscriptions = 2; - -} diff --git a/proto3/models/subscription_link_list_links_subscriptions.proto b/proto3/models/subscription_link_list_links_subscriptions.proto deleted file mode 100644 index 611fe6a623432eb30140e21e29f9afb2c201b3aa..0000000000000000000000000000000000000000 --- a/proto3/models/subscription_link_list_links_subscriptions.proto +++ /dev/null @@ -1,24 +0,0 @@ -/* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 - Contact: cti_support@etsi.org - Generated by OpenAPI Generator: https://openapi-generator.tech -*/ - -syntax = "proto3"; - -package mec030; - - -message SubscriptionLinkListLinksSubscriptions { - - // The URI referring to the subscription. - string href = 1; - - // Type of the subscription. The values are as defined in the \\\"subscription_type\\\" attribute for each different V2X information event subscription data type. - string subscription_type = 2; - -} diff --git a/proto3/models/subscriptions.proto b/proto3/models/subscriptions.proto new file mode 100644 index 0000000000000000000000000000000000000000..c1dc5ec196cab633f3cdac89c95721424c7c9ac8 --- /dev/null +++ b/proto3/models/subscriptions.proto @@ -0,0 +1,26 @@ +/* + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + + Contact: cti_support@etsi.org + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec030; + + +message Subscriptions { + + // The URI referring to the subscription. + string href = 1; + + // Type of the subscription. The values are as defined in the \"subscriptionType\" attribute for each different V2X information event subscription data type. + string subscriptionType = 2; + +} diff --git a/proto3/models/tdd_info.proto b/proto3/models/tdd_info.proto index ccf0b36e05fea71bb1636067b8edba2a315e24d6..1b1257ce0f56575b5a32ccba9e75dd03e5555d8b 100644 --- a/proto3/models/tdd_info.proto +++ b/proto3/models/tdd_info.proto @@ -1,10 +1,12 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ @@ -20,8 +22,8 @@ message TddInfo { Earfcn earfcn = 1; // Uplink-downlink subframe configuration information. - string subframe_assignment = 2; + string subframeAssignment = 2; - TransmissionBandwidth transmission_bandwidth = 3; + TransmissionBandwidth transmissionBandwidth = 3; } diff --git a/proto3/models/test_notification.proto b/proto3/models/test_notification.proto new file mode 100644 index 0000000000000000000000000000000000000000..b265488c11daf419c675481c1321dfca6243b348 --- /dev/null +++ b/proto3/models/test_notification.proto @@ -0,0 +1,26 @@ +/* + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + + Contact: cti_support@etsi.org + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec030; + +import public "models/test_notification_links.proto"; + +message TestNotification { + + TestNotificationLinks _links = 1; + + // Shall be set to \"TestNotification\". + string notificationType = 2; + +} diff --git a/proto3/models/test_notification_links.proto b/proto3/models/test_notification_links.proto new file mode 100644 index 0000000000000000000000000000000000000000..3e3a580379c56a37030c6b078e2bd62acd28abc2 --- /dev/null +++ b/proto3/models/test_notification_links.proto @@ -0,0 +1,23 @@ +/* + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + + Contact: cti_support@etsi.org + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec030; + +import public "models/link_type.proto"; + +message TestNotificationLinks { + + LinkType subscription = 1; + +} diff --git a/proto3/models/time_stamp.proto b/proto3/models/time_stamp.proto index f6f3b2619feaee48e30e44d21b3b3c510fc83d34..be197d60b898c2a957f0794a426b0f8cc6f07ae5 100644 --- a/proto3/models/time_stamp.proto +++ b/proto3/models/time_stamp.proto @@ -1,10 +1,12 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ @@ -16,7 +18,7 @@ package mec030; message TimeStamp { // The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC. - int32 nano_seconds = 1; + int32 nanoSeconds = 1; // The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC. int32 seconds = 2; diff --git a/proto3/models/transmission_bandwidth.proto b/proto3/models/transmission_bandwidth.proto index efb16e47c86ef6bc26662623467a0818a65cc0e4..809cfc230e25a94d22551bd1ff3d71f78416ef90 100644 --- a/proto3/models/transmission_bandwidth.proto +++ b/proto3/models/transmission_bandwidth.proto @@ -1,10 +1,12 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ @@ -16,6 +18,6 @@ import public "models/transmission_bandwidth_transmission_bandwidth.proto"; message TransmissionBandwidth { - TransmissionBandwidthTransmissionBandwidth transmission_bandwidth = 1; + TransmissionBandwidthTransmissionBandwidth transmissionBandwidth = 1; } diff --git a/proto3/models/transmission_bandwidth_transmission_bandwidth.proto b/proto3/models/transmission_bandwidth_transmission_bandwidth.proto index ab960071963ee6a80eb33c508cf7b107a1091234..e1d924d54418288c11b499900cb7f70867724508 100644 --- a/proto3/models/transmission_bandwidth_transmission_bandwidth.proto +++ b/proto3/models/transmission_bandwidth_transmission_bandwidth.proto @@ -1,10 +1,12 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ @@ -13,13 +15,11 @@ syntax = "proto3"; package mec030; -message TransmissionBandwidthTransmissionBandwidth { -enum TypeEnum { - TRANSMISSION_BANDWIDTH_TRANSMISSION_BANDWIDTH_TYPE_ENUM_1 = 0; - TRANSMISSION_BANDWIDTH_TRANSMISSION_BANDWIDTH_TYPE_ENUM_2 = 1; - TRANSMISSION_BANDWIDTH_TRANSMISSION_BANDWIDTH_TYPE_ENUM_3 = 2; - TRANSMISSION_BANDWIDTH_TRANSMISSION_BANDWIDTH_TYPE_ENUM_4 = 3; - TRANSMISSION_BANDWIDTH_TRANSMISSION_BANDWIDTH_TYPE_ENUM_5 = 4; - TRANSMISSION_BANDWIDTH_TRANSMISSION_BANDWIDTH_TYPE_ENUM_6 = 5; - } +enum TransmissionBandwidthTransmissionBandwidth { + _1 = 0; + _2 = 1; + _3 = 2; + _4 = 3; + _5 = 4; + _6 = 5; } diff --git a/proto3/models/uu_mbms_neighbour_cell_info.proto b/proto3/models/uu_mbms_neighbour_cell_info.proto index c6b92c3146a98611ea66a5f5d6ebd2d8c701cefc..58d6fb3bdb50dbb82bee9b10f916375b82f0b516 100644 --- a/proto3/models/uu_mbms_neighbour_cell_info.proto +++ b/proto3/models/uu_mbms_neighbour_cell_info.proto @@ -1,10 +1,12 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ @@ -19,18 +21,18 @@ import public "models/tdd_info.proto"; message UuMbmsNeighbourCellInfo { - Ecgi ecgi = 1; + Ecgi ecgi = 2; - FddInfo fdd_info = 2; + FddInfo fddInfo = 3; // Supported MBMS Service Area Identities in the cell. - repeated string mbms_service_area_identity = 3; + repeated string mbmsServiceAreaIdentity = 4; // Physical Cell Identifier. - int32 pci = 4; + int32 pci = 5; - Plmn plmn = 5; + Plmn plmn = 6; - TddInfo tdd_info = 6; + TddInfo tddInfo = 7; } diff --git a/proto3/models/uu_mbms_provisioning_info.proto b/proto3/models/uu_mbms_provisioning_info.proto index 1e64c19c08f696f8d134e7707f440e9e7db23d01..b93e776feffddd55726b12bf4a1c4e6b45c9c921 100644 --- a/proto3/models/uu_mbms_provisioning_info.proto +++ b/proto3/models/uu_mbms_provisioning_info.proto @@ -1,10 +1,12 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ @@ -17,8 +19,8 @@ import public "models/uu_mbms_provisioning_info_pro_info_uu_mbms.proto"; message UuMbmsProvisioningInfo { - UuMbmsProvisioningInfoProInfoUuMbms pro_info_uu_mbms = 1; + repeated UuMbmsProvisioningInfoProInfoUuMbms proInfoUuMbms = 1; - TimeStamp time_stamp = 2; + TimeStamp timeStamp = 2; } diff --git a/proto3/models/uu_mbms_provisioning_info_pro_info_uu_mbms.proto b/proto3/models/uu_mbms_provisioning_info_pro_info_uu_mbms.proto index d53981a5f8a8f564b6605700d50163d4dfcaf1fd..f918670cba12c08aa3f6b3b3c96afb3bcb56046c 100644 --- a/proto3/models/uu_mbms_provisioning_info_pro_info_uu_mbms.proto +++ b/proto3/models/uu_mbms_provisioning_info_pro_info_uu_mbms.proto @@ -1,10 +1,12 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ @@ -18,11 +20,11 @@ import public "models/v2x_server_usd.proto"; message UuMbmsProvisioningInfoProInfoUuMbms { - LocationInfo location_info = 1; + LocationInfo locationInfo = 1; // The information of the neighbour cells in a visiting PLMN that support V2X communication over Uu MBMS. - repeated UuMbmsNeighbourCellInfo neighbour_cell_info = 2; + repeated UuMbmsNeighbourCellInfo neighbourCellInfo = 2; - V2xServerUsd v2x_server_usd = 3; + V2xServerUsd v2xServerUsd = 3; } diff --git a/proto3/models/uu_uni_neighbour_cell_info.proto b/proto3/models/uu_uni_neighbour_cell_info.proto index eb8192c6a93ec150e056a725db87d73bba9f8e9d..0d6e4e5e78df812c50ac3b3ccea9521d94c7b785 100644 --- a/proto3/models/uu_uni_neighbour_cell_info.proto +++ b/proto3/models/uu_uni_neighbour_cell_info.proto @@ -1,10 +1,12 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ @@ -21,13 +23,13 @@ message UuUniNeighbourCellInfo { Ecgi ecgi = 1; - FddInfo fdd_info = 2; + FddInfo fddInfo = 2; // Physical Cell Identifier. int32 pci = 3; Plmn plmn = 4; - TddInfo tdd_info = 5; + TddInfo tddInfo = 5; } diff --git a/proto3/models/uu_unicast_provisioning_info.proto b/proto3/models/uu_unicast_provisioning_info.proto index 7e205864cfd719919d11387ad59d0ff816c9bbc2..e27ff9c7a34ba30ed4c2ca2bd923c89a6e85ac37 100644 --- a/proto3/models/uu_unicast_provisioning_info.proto +++ b/proto3/models/uu_unicast_provisioning_info.proto @@ -1,10 +1,12 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ @@ -17,8 +19,8 @@ import public "models/uu_unicast_provisioning_info_pro_info_uu_unicast.proto"; message UuUnicastProvisioningInfo { - repeated UuUnicastProvisioningInfoProInfoUuUnicast pro_info_uu_unicast = 1; + repeated UuUnicastProvisioningInfoProInfoUuUnicast proInfoUuUnicast = 437861045; - TimeStamp time_stamp = 2; + TimeStamp timeStamp = 1; } diff --git a/proto3/models/uu_unicast_provisioning_info_pro_info_uu_unicast.proto b/proto3/models/uu_unicast_provisioning_info_pro_info_uu_unicast.proto index 695979b3c657545caa09c30ff84bc3d2970c0d29..1e68f0d0c1120af9aa70c12789617d72d9bd0601 100644 --- a/proto3/models/uu_unicast_provisioning_info_pro_info_uu_unicast.proto +++ b/proto3/models/uu_unicast_provisioning_info_pro_info_uu_unicast.proto @@ -1,10 +1,12 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ @@ -18,11 +20,11 @@ import public "models/v2x_application_server.proto"; message UuUnicastProvisioningInfoProInfoUuUnicast { - LocationInfo location_info = 1; + LocationInfo locationInfo = 1; // The information of the neighbour cells in a visiting PLMN that support V2X communication over Uu unicast. - repeated UuUniNeighbourCellInfo neighbour_cell_info = 2; + repeated UuUniNeighbourCellInfo neighbourCellInfo = 2; - V2xApplicationServer v2x_application_server = 3; + V2xApplicationServer v2xApplicationServer = 3; } diff --git a/proto3/models/v2x_application_server.proto b/proto3/models/v2x_application_server.proto index 8aa8c6464277bb7d8fd51eef26d7a1290fdd8ce9..a5e4af9e39817b3880d115c99cc58e2eaccc8cbc 100644 --- a/proto3/models/v2x_application_server.proto +++ b/proto3/models/v2x_application_server.proto @@ -1,10 +1,12 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ @@ -12,12 +14,11 @@ syntax = "proto3"; package mec030; -option java_outer_classname = "V2xApplicationServerProto"; message V2xApplicationServer { - string ip_address = 1; + string ipAddress = 1; - string udp_port = 2; + string udpPort = 2; } diff --git a/proto3/models/v2x_msg_distribution_server.proto b/proto3/models/v2x_msg_distribution_server.proto new file mode 100644 index 0000000000000000000000000000000000000000..51c7f5f441831d0fb73b855dffd5ac4a355f5b9b --- /dev/null +++ b/proto3/models/v2x_msg_distribution_server.proto @@ -0,0 +1,26 @@ +/* + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + + Contact: cti_support@etsi.org + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec030; + +import public "models/info_connection.proto"; +import public "models/info_protocol.proto"; + +message V2xMsgDistributionServer { + + InfoConnection infoConnection = 1; + + InfoProtocol infoProtocol = 2; + +} diff --git a/proto3/models/v2x_msg_distribution_server_info.proto b/proto3/models/v2x_msg_distribution_server_info.proto new file mode 100644 index 0000000000000000000000000000000000000000..ea265c1c8a8de76cd66c0111564ddd1b5f55c7f6 --- /dev/null +++ b/proto3/models/v2x_msg_distribution_server_info.proto @@ -0,0 +1,28 @@ +/* + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + + Contact: cti_support@etsi.org + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec030; + +import public "models/location_info.proto"; +import public "models/v2x_msg_distribution_server.proto"; + +message V2xMsgDistributionServerInfo { + + // Location information to identify a particular geographical area of interest to the service consumer for receiving V2X messages. + repeated LocationInfo locationInfo = 1; + + // Describes the information of the V2X Message Distribution Servers supported by the service consumer for direct communication. + repeated V2xMsgDistributionServer v2xMsgDistributionServer = 2; + +} diff --git a/proto3/models/v2x_msg_filter_criteria.proto b/proto3/models/v2x_msg_filter_criteria.proto new file mode 100644 index 0000000000000000000000000000000000000000..88ef20444779bdd4c1db6419fba72fe64cc38b7d --- /dev/null +++ b/proto3/models/v2x_msg_filter_criteria.proto @@ -0,0 +1,41 @@ +/* + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + + Contact: cti_support@etsi.org + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec030; + +import public "models/location_info.proto"; + +message V2xMsgFilterCriteria { + + // Location information to identify a cell of a base station or a particular geographical area to which the V2X message can be associated. + repeated LocationInfo locationInfo = 1; + + // Protocol version of the V2X message (0..255), See note 3. + repeated int32 msgProtocolVersion = 2; + + // Published V2X message type. Its value is defined by the standardization organization indicated by the attribute stdOrganization. See note 2. + enum MsgTypeEnum { + SEE_DESCRIPTION = 0; + } + + MsgTypeEnum msgType = 3; + + // Standardization organization which defines the published V2X message type: ETSI: European Telecommunications Standards Institute. See note 1. + enum StdOrganizationEnum { + SEE_DESCRIPTION_1 = 0; + } + + StdOrganizationEnum stdOrganization = 4; + +} diff --git a/proto3/models/v2x_msg_notification.proto b/proto3/models/v2x_msg_notification.proto index 31ba38001f605ff369357ca07bd98b104aa2e916..5c216fe11c42586cf8ef84cfc25b0418c5dc5757 100644 --- a/proto3/models/v2x_msg_notification.proto +++ b/proto3/models/v2x_msg_notification.proto @@ -1,10 +1,12 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ @@ -12,32 +14,25 @@ syntax = "proto3"; package mec030; -import public "models/msg_type.proto"; +import public "models/links3.proto"; import public "models/time_stamp.proto"; -import public "models/v2x_msg_notification_links.proto"; - -option java_outer_classname = "V2xMsgNotificationProto"; +import public "models/v2x_msg_properties_values.proto"; message V2xMsgNotification { - // Shall be set to \"V2xMsgNotification\". - string notification_type = 1; - - TimeStamp time_stamp = 2; + Links3 _links = 1; - // Standardization organization which defines the published V2X message type ETSI: European Telecommunications Standards Institute. See note 1. - enum stdOrganization { - ETSI = 0; - } + // Published V2X message content. The format of the string is defined by the standardization organization indicated by the attribute stdOrganization of the msgPropertiesValues attribute. + string msgContent = 2; - MsgType msg_type = 4; + V2xMsgPropertiesValues msgPropertiesValues = 3; - // The encode format of the V2X message, for example base64 - string msg_encode_format = 5; + // The representation format of the binary V2X message, for example base64 or hexadecimal representation. + string msgRepresentationFormat = 4; - // Published V2X message content. The format of the string is defined by the standardization organization indicated by the attribute stdOrganization. - string msg_content = 6; + // Shall be set to \"V2xMsgNotification\". + string notificationType = 5; - V2xMsgNotificationLinks links = 7; + TimeStamp timeStamp = 6; } diff --git a/proto3/models/v2x_msg_notification_links.proto b/proto3/models/v2x_msg_notification_links.proto index 5bc0123c1ad67a8750a110446007d002b954fc33..889dc975bcc010b4ac44ea424588b136f9bfdd37 100644 --- a/proto3/models/v2x_msg_notification_links.proto +++ b/proto3/models/v2x_msg_notification_links.proto @@ -1,17 +1,18 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ syntax = "proto3"; package mec030; -option java_outer_classname = "V2xMsgNotificationLinksProto"; import public "models/link_type.proto"; diff --git a/proto3/models/v2x_msg_properties_values.proto b/proto3/models/v2x_msg_properties_values.proto new file mode 100644 index 0000000000000000000000000000000000000000..7773a43149a82446f070ee15e46270174d5a8ee3 --- /dev/null +++ b/proto3/models/v2x_msg_properties_values.proto @@ -0,0 +1,40 @@ +/* + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + + Contact: cti_support@etsi.org + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec030; + +import public "models/location_info.proto"; + +message V2xMsgPropertiesValues { + + LocationInfo locationInfo = 1; + + // Protocol version of the V2X message (0..255), See note 3. + int32 msgProtocolVersion = 2; + + // Published V2X message type. Its value is defined by the standardization organization indicated by the attribute stdOrganization. See note 2. + enum MsgTypeEnum { + SEE_DESCRIPTION = 0; + } + + MsgTypeEnum msgType = 3; + + // Standardization organization which defines the published V2X message type: ETSI: European Telecommunications Standards Institute. See note 1. + enum StdOrganizationEnum { + SEE_DESCRIPTION_1 = 0; + } + + StdOrganizationEnum stdOrganization = 4; + +} diff --git a/proto3/models/v2x_msg_publication.proto b/proto3/models/v2x_msg_publication.proto index ea9d00ea23fda6cea0454888be759e252605131f..93b26b2686098b7473760cef354fa43dec34ee4a 100644 --- a/proto3/models/v2x_msg_publication.proto +++ b/proto3/models/v2x_msg_publication.proto @@ -1,10 +1,12 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ @@ -12,23 +14,16 @@ syntax = "proto3"; package mec030; -import public "models/msg_type.proto"; - -option java_outer_classname = "V2xMsgPublicationProto"; +import public "models/v2x_msg_properties_values.proto"; message V2xMsgPublication { - // Published V2X message content. Its format is defined by the standardization organization indicated by the attribute stdOrganization. - string msg_content = 1; - - // The encode format of the V2X message, for example base64. - string msg_encode_format = 2; + // Published V2X message content. Its format is defined by the standardization organization indicated by the attribute stdOrganization of the msgPropertiesValues attribute. + string msgContent = 1; - MsgType msg_type = 3; + V2xMsgPropertiesValues msgPropertiesValues = 2; - // Standardization organization which defines the published V2X message type: ETSI: European Telecommunications Standards Institute. See note 1. - enum stdOrganization { - ETSI = 0; - } + // The representation format of the binary V2X message, for example base64 or hexadecimal representation. + string msgRepresentationFormat = 3; } diff --git a/proto3/models/v2x_msg_subscription.proto b/proto3/models/v2x_msg_subscription.proto index c4908d900b4c337c366ba2800b201dc917f5acaf..cf7ee1ba83ef339df261912451d7722e39128bdc 100644 --- a/proto3/models/v2x_msg_subscription.proto +++ b/proto3/models/v2x_msg_subscription.proto @@ -1,10 +1,12 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ @@ -12,23 +14,28 @@ syntax = "proto3"; package mec030; +import public "models/links.proto"; import public "models/time_stamp.proto"; -import public "models/v2x_msg_subscription_filter_criteria.proto"; -import public "models/v2x_msg_subscription_links.proto"; +import public "models/v2x_msg_filter_criteria.proto"; +import public "models/websock_notif_config.proto"; -option java_outer_classname = "V2xMsgSubscriptionProto"; message V2xMsgSubscription { - V2xMsgSubscriptionLinks links = 1; + Links _links = 1; + + // URI exposed by the client on which to receive notifications via HTTP. See note. + string callbackReference = 2; - // URI selected by the service consumer to receive notifications on the subscribed V2X message. This shall be included both in the request and in response. - string callback_reference = 2; + TimeStamp expiryDeadline = 3; - TimeStamp expiry_deadline = 3; + V2xMsgFilterCriteria filterCriteria = 4; - V2xMsgSubscriptionFilterCriteria filter_criteria = 4; + // Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as described in ETSI GS MEC 009 [9], clause 6.12a. Default: FALSE. + bool requestTestNotification = 5; // Shall be set to \"V2xMsgSubscription\". - string subscription_type = 5; + string subscriptionType = 6; + + WebsockNotifConfig websockNotifConfig = 7; } diff --git a/proto3/models/v2x_msg_subscription_filter_criteria.proto b/proto3/models/v2x_msg_subscription_filter_criteria.proto index 1283c6ceeb0e3caab3c32d9ea7f95e1d95a1e195..a3049e9b6e2f4b8dd7187ad97e03d46718e47db1 100644 --- a/proto3/models/v2x_msg_subscription_filter_criteria.proto +++ b/proto3/models/v2x_msg_subscription_filter_criteria.proto @@ -1,27 +1,30 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ syntax = "proto3"; package mec030; -option java_outer_classname = "V2xMsgSubscriptionFilterCriteriaProto"; message V2xMsgSubscriptionFilterCriteria { - // Subscribed V2X message type. Its value is defined by the standardization organization indicated by the attribute stdOrganization. See note 2. - repeated string msg_type = 1; + // Subscribed V2X message type. Its value is defined by the standardization organization indicated by the attribute stdOrganization. See note 3. + repeated string msgType = 1; - // Standardization organization which defines the subscribed V2X message type: ETSI: European Telecommunications Standards Institute. See note 1. - enum stdOrganization { + // Standardization organization which defines the subscribed V2X message type: ETSI: European Telecommunications Standards Institute. See note 2. + enum StdOrganizationEnum { ETSI = 0; } + StdOrganizationEnum stdOrganization = 2; + } diff --git a/proto3/models/v2x_msg_subscription_links.proto b/proto3/models/v2x_msg_subscription_links.proto deleted file mode 100644 index fc22f1d3996ed5815a2aab78841f588be8392428..0000000000000000000000000000000000000000 --- a/proto3/models/v2x_msg_subscription_links.proto +++ /dev/null @@ -1,23 +0,0 @@ -/* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 - Contact: cti_support@etsi.org - Generated by OpenAPI Generator: https://openapi-generator.tech -*/ - -syntax = "proto3"; - -package mec030; - -import public "models/link_type.proto"; - -option java_outer_classname = "V2xMsgSubscriptionLinksProto"; - -message V2xMsgSubscriptionLinks { - - LinkType self = 1; - -} diff --git a/proto3/models/v2x_server_usd.proto b/proto3/models/v2x_server_usd.proto index 81c04bb3e12f96f62eb2881010b5e06a2f4dc286..43d55aee7b551113942f9c50eb1d7de7e1b0703f 100644 --- a/proto3/models/v2x_server_usd.proto +++ b/proto3/models/v2x_server_usd.proto @@ -1,10 +1,12 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ @@ -15,14 +17,12 @@ package mec030; import public "models/v2x_server_usd_sdp_info.proto"; import public "models/v2x_server_usd_tmgi.proto"; -option java_outer_classname = "V2xServerUsdProto"; - message V2xServerUsd { - V2xServerUsdSdpInfo sdp_info = 1; + V2xServerUsdSdpInfo sdpInfo = 1; // A list of service area identifier for the applicable MBMS broadcast area. - repeated string service_area_identifier = 2; + repeated string serviceAreaIdentifier = 2; V2xServerUsdTmgi tmgi = 3; diff --git a/proto3/models/v2x_server_usd_sdp_info.proto b/proto3/models/v2x_server_usd_sdp_info.proto index 1195d26bd78f9daabdfd087728775cca9c6507c3..39349f6071aecd77ae3412634e384188fc154b76 100644 --- a/proto3/models/v2x_server_usd_sdp_info.proto +++ b/proto3/models/v2x_server_usd_sdp_info.proto @@ -1,10 +1,12 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ @@ -12,12 +14,11 @@ syntax = "proto3"; package mec030; -option java_outer_classname ="V2xServerUsdSdpInfoProto"; message V2xServerUsdSdpInfo { - string ip_multicast_address = 1; + string ipMulticastAddress = 1; - string port_number = 2; + string portNumber = 2; } diff --git a/proto3/models/v2x_server_usd_tmgi.proto b/proto3/models/v2x_server_usd_tmgi.proto index edc3995067a5872406e87ea77f46700d1e5978ad..7ba8de5b10e026dfa02165a5fc2d62dad8f5acdf 100644 --- a/proto3/models/v2x_server_usd_tmgi.proto +++ b/proto3/models/v2x_server_usd_tmgi.proto @@ -1,10 +1,12 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ @@ -12,12 +14,11 @@ syntax = "proto3"; package mec030; -option java_outer_classname ="V2xServerUsdTmgiProto"; message V2xServerUsdTmgi { // MBMS Service ID consisting of three octets. - string mbms_service_id = 1; + string mbmsServiceId = 1; // The Mobile Country Code part of PLMN Identity. string mcc = 2; diff --git a/proto3/models/websock_notif_config.proto b/proto3/models/websock_notif_config.proto new file mode 100644 index 0000000000000000000000000000000000000000..010f92800c71570a5c2b6f5608b9d865cb31f7a2 --- /dev/null +++ b/proto3/models/websock_notif_config.proto @@ -0,0 +1,26 @@ +/* + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + + Contact: cti_support@etsi.org + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec030; + + +message WebsockNotifConfig { + + // Set to TRUE by the service consumer to indicate that Websocket delivery is requested. + bool requestWebsocketUri = 1; + + // Set by VIS to indicate to the service consumer the Websocket URI to be used for delivering notifications. + string websocketUri = 2; + +} diff --git a/proto3/services/qo_s_service.proto b/proto3/services/qo_s_service.proto index d9d5bb7be17ec49177098f63a20d802cc9f00413..5f6d23fa34a3b703a5eac666fb47135571193b20 100644 --- a/proto3/services/qo_s_service.proto +++ b/proto3/services/qo_s_service.proto @@ -1,16 +1,18 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ syntax = "proto3"; -package mec030; +package mec030.services.qosservice; import public "models/predicted_qos.proto"; import public "models/problem_details.proto"; @@ -21,7 +23,7 @@ service QoSService { } message PredictedQosPOSTRequest { - PredictedQos predicted_qos = 1; + PredictedQos predictedQos = 1; } diff --git a/proto3/services/queries_service.proto b/proto3/services/queries_service.proto index 50e73a9100681e18858d0dcc5bfb2a82e0b17993..7ef26975c0ec5428fbd3f7d89bf9a2d272729f2c 100644 --- a/proto3/services/queries_service.proto +++ b/proto3/services/queries_service.proto @@ -1,16 +1,18 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ syntax = "proto3"; -package mec030; +package mec030.services.queriesservice; import public "models/pc5_provisioning_info.proto"; import public "models/problem_details.proto"; @@ -28,19 +30,19 @@ service QueriesService { message ProvInfoGETRequest { // Comma separated list of locations to identify a cell of a base station or a particular geographical area - string location_info = 1; + string locationInfo = 1; } message ProvInfoUuMbmsGETRequest { // omma separated list of locations to identify a cell of a base station or a particular geographical area - string location_info = 1; + string locationInfo = 1; } message ProvInfoUuUnicastGETRequest { // Comma separated list of locations to identify a cell of a base station or a particular geographical area - string location_info = 1; + string locationInfo = 1; } diff --git a/proto3/services/subscription_service.proto b/proto3/services/subscription_service.proto index e75d351eb40139f3c1504d0826cd87ab7e490da6..ba45e3582b0889d1feaf7969ac7caf3e69aa9a75 100644 --- a/proto3/services/subscription_service.proto +++ b/proto3/services/subscription_service.proto @@ -1,20 +1,22 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ syntax = "proto3"; -package mec030; +package mec030.services.subscriptionservice; import "google/protobuf/empty.proto"; -import public "models/subscription.proto"; import public "models/problem_details.proto"; +import public "models/subscription.proto"; import public "models/subscription_link_list.proto"; service SubscriptionService { @@ -32,31 +34,30 @@ service SubscriptionService { message IndividualSubscriptionDELETERequest { // Refers to created subscription, where the VIS API allocates a unique resource name for this subscription - string subscription_id = 1; + string subscriptionId = 1; } message IndividualSubscriptionGETRequest { // Refers to created subscription, where the VIS API allocates a unique resource name for this subscription - string subscription_id = 1; + string subscriptionId = 1; } message IndividualSubscriptionPUTRequest { // Refers to created subscription, where the VIS API allocates a unique resource name for this subscription - string subscription_id = 1; + string subscriptionId = 1; Subscription subscription = 2; } message SubGETRequest { - // 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 - string subscription_type = 1; + // 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. pred_qos: information on the predicted QoS + string subscriptionType = 1; } message SubPOSTRequest { Subscription subscription = 1; - } diff --git a/proto3/services/v2_x_msg_service.proto b/proto3/services/v2_x_msg_service.proto index bf580b97c0bd4c00cf7b0af4392e64f86d4f4b3a..0706387d1346cf8995058b6b2e3d7c3d64246f2b 100644 --- a/proto3/services/v2_x_msg_service.proto +++ b/proto3/services/v2_x_msg_service.proto @@ -1,28 +1,38 @@ /* - ETSI GS MEC 030 V2X Information Service API - - ETSI GS MEC 030 V2X Information Service API described using OpenAPI. - - The version of the OpenAPI document: 2.1.1 + ETSI GS MEC 030 V2X Information Services API + + ETSI GS MEC 030 V2X Information Services API described using OpenAPI. + + The version of the OpenAPI document: 3.1.1 + Contact: cti_support@etsi.org + Generated by OpenAPI Generator: https://openapi-generator.tech */ syntax = "proto3"; -package mec030; +package mec030.services.v2xmsgservice; import "google/protobuf/empty.proto"; import public "models/problem_details.proto"; +import public "models/v2x_msg_distribution_server_info.proto"; import public "models/v2x_msg_publication.proto"; service V2XMsgService { rpc V2xMessagePOST (V2xMessagePOSTRequest) returns (google.protobuf.Empty); + rpc V2xMsgDistributionServerPost (V2xMsgDistributionServerPostRequest) returns (V2xMsgDistributionServerInfo); + } message V2xMessagePOSTRequest { - V2xMsgPublication v2x_msg_publication = 1; + V2xMsgPublication v2xMsgPublication = 1; + +} + +message V2xMsgDistributionServerPostRequest { + V2xMsgDistributionServerInfo v2xMsgDistributionServerInfo = 1; }