From d71bef26d1dba41b298e55760da9b96670dbe7c8 Mon Sep 17 00:00:00 2001 From: Elian Kraja Date: Mon, 13 Dec 2021 15:08:11 +0100 Subject: [PATCH 1/6] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0be4cfa..3e72070 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,8 @@ This repository contains OpenAPIs descriptions for the interfaces specified in E ## Online resources * [Specification document](https://www.etsi.org/deliver/etsi_gs/MEC/001_099/030/02.01.01_60/gs_MEC030v020101p.pdf) -* [Navigate the V2X Information Service API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/mec/gs030-vis-api/raw/v2.1.1/MEC030_V2XInformationService.yaml). -* [Edit the V2X Information Service API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/rep/mec/gs030-vis-api/raw/v2.1.1/MEC030_V2XInformationService.yaml). +* [Navigate the V2X Information Service API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/mec/gs030-vis-api/raw/stf606-draft/MEC030_V2XInformationService.yaml). +* [Edit the V2X Information Service API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/rep/mec/gs030-vis-api/raw/stf606-draft/MEC030_V2XInformationService.yaml). ## License -- GitLab From b1f82821e24674acac0182352595061efd9ee1a9 Mon Sep 17 00:00:00 2001 From: "M. Rehan Abbasi" Date: Fri, 11 Feb 2022 11:47:25 +0500 Subject: [PATCH 2/6] update MEC030 to v2.2.1 --- MEC030_V2XInformationService.json | 1169 +++++++++++++++------------ MEC030_V2XInformationService.yaml | 1257 ++++++++++++++++------------- 2 files changed, 1345 insertions(+), 1081 deletions(-) diff --git a/MEC030_V2XInformationService.json b/MEC030_V2XInformationService.json index 51311a9..929a9e8 100644 --- a/MEC030_V2XInformationService.json +++ b/MEC030_V2XInformationService.json @@ -2,7 +2,7 @@ "openapi": "3.1.0", "info": { "title": "ETSI GS MEC 030 V2X Information Service API", - "version": "2.1.1", + "version": "2.2.1", "description": "ETSI GS MEC 030 V2X Information Service API described using OpenAPI.", "contact": { "name": "ETSI Forge", @@ -15,12 +15,12 @@ } }, "externalDocs": { - "description": "ETSI GS MEC 030 V2X Information Service API, v2.1.1", - "url": "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/030/02.01.01_60/gs_mec030v020101p.pdf" + "description": "ETSI GS MEC 030 V2X Information Service API, v2.2.1", + "url": "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/030/02.02.01_60/gs_mec030v020201p.pdf" }, "servers": [ { - "url": "https://localhost/vis/v1" + "url": "https://localhost/vis/v2" } ], "tags": [ @@ -31,6 +31,12 @@ { "name": "subscription", "description": "Subscription" + }, + { + "name": "QoS" + }, + { + "name": "V2X_msg" } ], "paths": { @@ -660,27 +666,19 @@ "type": "object", "x-etsi-ref": "6.5.6" }, - "LocationInfo.geoArea": { - "description": "Information of a geographical area.", + "LinkType": { "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", + "href": { + "description": "URI referring to a resource", + "format": "uri", + "type": "string", "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Float" + "x-etsi-mec-origin-type": "Uri" } }, - "required": ["latitude", "longitude"], + "required": ["href"], "type": "object", - "x-etsi-mec-cardinality": "0..1" + "x-etsi-ref": "6.5.13" }, "LocationInfo": { "properties": { @@ -688,7 +686,27 @@ "$ref": "#/components/schemas/Ecgi" }, "geoArea": { - "$ref": "#/components/schemas/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)" } }, "type": "object", @@ -704,50 +722,53 @@ "$ref": "#/components/schemas/Plmn" }, "siV2xConfig": { - "description": "V2X sidelink communication configuration, as defined in ETSI TS 136 331 [i.11].", - "type": "string" + "$ref": "#/components/schemas/SystemInformationBlockType21" } }, "required": ["plmn", "ecgi", "siV2xConfig"], "type": "object", "x-etsi-ref": "6.5.12" }, - "Pc5ProvisioningInfo.proInfoPc5": { - "description": "The provisioning information per location as defined below.", - "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 Layer-2 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"] - }, "Pc5ProvisioningInfo": { - "properties": { - "proInfoPc5": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Pc5ProvisioningInfo.proInfoPc5" + "items": { + "properties": { + "proInfoPc5": { + "description": "The provisioning information per location as defined below.", + "items": { + "type": "object" + }, + "minItems": 1, + "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"], + "type": "array", + "x-etsi-mec-cardinality": "1..N", + "x-etsi-mec-origin-type": "Structure (inlined)" + }, + "timeStamp": { + "$ref": "#/components/schemas/TimeStamp" } }, - "timeStamp": { - "$ref": "#/components/schemas/TimeStamp" - } + "type": "object" }, "required": ["proInfoPc5"], "type": "object", @@ -772,60 +793,106 @@ "type": "object", "x-etsi-ref": "6.5.4" }, - "PredictedQos.routes.routeInfo": { - "required": ["location"], + "PredictedQos": { "properties": { - "location": { - "$ref": "#/components/schemas/LocationInfo" - }, - "time": { - "$ref": "#/components/schemas/TimeStamp" - }, - "rsrp": { - "description": "Reference Signal Received Quality as defined in ETSI TS 136 214 [i.13]. Shall only be included in the response", - "type": "integer", - "format": "Uint8" + "locationGranularity": { + "description": "Granularity of visited location. Measured in meters.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" }, - "rsrq": { - "description": "Reference Signal Received Quality as defined in ETSI TS 136 214 [i.13]. Shall only be included in the response", - "type": "integer", - "format": "Uint8" - } - } - }, - "PredictedQos.routes": { - "properties": { - "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. ", - "type": "array", - "minItems": 2, + "routes": { + "description": "Information relating to the potential routes of a vehicular UE.", "items": { - "$ref": "#/components/schemas/PredictedQos.routes.routeInfo" - } + "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": { + "type": "object" + }, + "minItems": 2, + "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" + } + }, + "required": ["location"], + "type": "array", + "x-etsi-mec-cardinality": "2..N", + "x-etsi-mec-origin-type": "Structure (inlined)" + } + }, + "type": "object" + }, + "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": ["routeinfo"] + "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": { - "description": "predicted QoS of a vehicular UE", + "ProblemDetails": { "properties": { - "timeGranularity": { - "$ref": "#/components/schemas/TimeStamp" + "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" }, - "locationGranularity": { - "description": "Granularity of visited location. Measured in meters", - "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" }, - "routes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/PredictedQos.routes" - } + "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" } }, - "required": ["locationGranularity", "routes"], - "type": "object", - "x-etsi-mec-cardinality": "0..1" + "type": "object" }, "ProvChgPc5Notification": { "properties": { @@ -862,71 +929,77 @@ "type": "object", "x-etsi-ref": "6.4.4" }, - "ProvChgPc5Subscription.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" - }, - "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" - }, "ProvChgPc5Subscription": { "properties": { "_links": { - "$ref": "#/components/schemas/ProvChgPc5Subscription.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)" }, "callbackReference": { - "description": "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.", + "description": "URI exposed by the client on which to receive notifications via HTTP. See note.", "format": "uri", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "URI" + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uri" }, "expiryDeadline": { "$ref": "#/components/schemas/TimeStamp" }, "filterCriteria": { - "$ref": "#/components/schemas/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)" + }, + "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", "callbackReference", "filterCriteria"], + "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" }, "ProvChgUuMbmsNotification": { @@ -961,68 +1034,74 @@ "type": "object", "x-etsi-ref": "6.4.3" }, - "ProvChgUuMbmsSubscription.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" - }, - "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" - }, "ProvChgUuMbmsSubscription": { "properties": { "_links": { - "$ref": "#/components/schemas/ProvChgUuMbmsSubscription.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)" }, "callbackReference": { - "description": "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.", + "description": "URI exposed by the client on which to receive notifications via HTTP. See note.", "format": "uri", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "URI" + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uri" }, "expiryDeadline": { "$ref": "#/components/schemas/TimeStamp" }, "filterCriteria": { - "$ref": "#/components/schemas/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)" + }, + "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", "callbackReference", "filterCriteria"], + "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" }, "ProvChgUuUniNotification": { @@ -1057,117 +1136,127 @@ "type": "object", "x-etsi-ref": "6.4.2" }, - "ProvChgUuUniSubscription.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" - }, - "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" - }, "ProvChgUuUniSubscription": { "properties": { "_links": { - "$ref": "#/components/schemas/ProvChgUuUniSubscription.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)" }, "callbackReference": { - "description": "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.", + "description": "URI exposed by the client on which to receive notifications via HTTP. See note.", "format": "uri", "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "URI" + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uri" }, "expiryDeadline": { "$ref": "#/components/schemas/TimeStamp" }, "filterCriteria": { - "$ref": "#/components/schemas/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)" + }, + "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", "callbackReference", "filterCriteria"], + "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" }, - "SubscriptionLinkList.links.subscriptions": { - "description": "The service consumer’s subscriptions.", + "SubscriptionLinkList": { "properties": { - "href": { - "description": "The URI referring to the subscription.", - "format": "uri", - "type": "string", + "_links": { + "description": "List of hyperlinks related to the resource.", + "items": { + "properties": { + "self": { + "$ref": "#/components/schemas/LinkType" + }, + "subscriptions": { + "description": "The service consumer's subscriptions.", + "items": { + "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"], + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "Structure (inlined)" + } + }, + "type": "object" + }, + "required": ["self"], + "type": "object", "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" - }, - "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" - } - } - }, - "type": "object", - "required": ["self"], - "x-etsi-mec-cardinality": "1" - }, - "SubscriptionLinkList": { - "properties": { - "_links": { - "$ref": "#/components/schemas/SubscriptionLinkList.links" + "x-etsi-mec-origin-type": "Structure (inlined)" } }, "required": ["_links"], "type": "object", "x-etsi-ref": "6.3.6" }, + "SystemInformationBlockType21": { + "type": "object" + }, "TddInfo": { "properties": { "earfcn": { @@ -1187,18 +1276,43 @@ "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", + "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", + "format": "uint32", "type": "integer", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "Uint32" @@ -1208,17 +1322,14 @@ "type": "object", "x-etsi-ref": "6.5.2" }, - "TransmissionBandwidth.transmissionBandwidth": { - "description": "Numeric value corresponding to the transmission bandwidth expressed in units of resource blocks as follows:1 = bw6 (6 resource blocks)2 = bw15 (15 resource blocks) 3 = bw25 (25 resource blocks) 4 = bw50 (50 resource blocks) 5 = bw75 (75 resource blocks) 6 = bw100 (100 resource blocks)", - "enum": [1, 2, 3, 4, 5, 6], - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Enum" - }, "TransmissionBandwidth": { "properties": { "transmissionBandwidth": { - "$ref": "#/components/schemas/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": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Enum" } }, "required": ["transmissionBandwidth"], @@ -1267,36 +1378,43 @@ "type": "object", "x-etsi-ref": "6.5.11" }, - "UuMbmsProvisioningInfo.proInfoUuMbms": { - "description": "The provisioning information per location as defined below.", - "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.", - "type": "array", - "items": { - "$ref": "#/components/schemas/UuMbmsNeighbourCellInfo" - }, - "minItems": 0, - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "UuMbmsNeighbourCellInfo" - }, - "v2xServerUsd": { - "$ref": "#/components/schemas/V2xServerUsd" - } - }, - "required": ["locationInfo", "v2xServerUsd"] - }, "UuMbmsProvisioningInfo": { - "properties": { - "proInfoUuMbms": { - "$ref": "#/components/schemas/UuMbmsProvisioningInfo.proInfoUuMbms" + "items": { + "properties": { + "proInfoUuMbms": { + "description": "The provisioning information per location as defined below.", + "items": { + "type": "object" + }, + "minItems": 1, + "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": "array", + "x-etsi-mec-cardinality": "1..N", + "x-etsi-mec-origin-type": "Structure (inlined)" + }, + "timeStamp": { + "$ref": "#/components/schemas/TimeStamp" + } }, - "timeStamp": { - "$ref": "#/components/schemas/TimeStamp" - } + "type": "object" }, "required": ["proInfoUuMbms"], "type": "object", @@ -1327,40 +1445,43 @@ "type": "object", "x-etsi-ref": "6.5.9" }, - "UuUnicastProvisioningInfo.proInfoUuUnicast": { - "description": "The provisioning information per location as defined below.", - "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" - }, "UuUnicastProvisioningInfo": { - "properties": { - "proInfoUuUnicast": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UuUnicastProvisioningInfo.proInfoUuUnicast" + "items": { + "properties": { + "proInfoUuUnicast": { + "description": "The provisioning information per location as defined below.", + "items": { + "type": "object" + }, + "minItems": 1, + "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": "array", + "x-etsi-mec-cardinality": "1..N", + "x-etsi-mec-origin-type": "Structure (inlined)" + }, + "timeStamp": { + "$ref": "#/components/schemas/TimeStamp" } }, - "timeStamp": { - "$ref": "#/components/schemas/TimeStamp" - } + "type": "object" }, "required": ["proInfoUuUnicast"], "type": "object", @@ -1385,17 +1506,22 @@ "type": "object", "x-etsi-ref": "6.5.8" }, - "msgType": { - "description": "− denm(1): Decentralized Environmental Notification Message (DENM) as specified in ETSI EN 302 637-3 [i.3], − cam(2): Cooperative Awareness Message (CAM) as specified in ETSI EN 302 637-2 [i.2], − poi(3): Point of Interest message as specified in ETSI TS 101 556-1 [i.11], − spat(4): Signal Phase And Timing (SPAT) message as specified in SAE J2735 [i.12], − map(5): MAP message as specified in SAE J2735 [i.12], − ivi(6): In Vehicle Information (IVI) message as defined in ISO TS 19321 [i.13], − ev-rsr(7): Electric vehicle recharging spot reservation message, as defined in ETSI TS 101 556-3 [i.14], ", - "enum": [1, 2, 3, 4, 5, 6, 7], - "type": "integer", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Enum" - }, - "V2xMsgPublication": { + "V2xMsgNotification": { "properties": { + "_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)" + }, "msgContent": { - "description": "Published V2X message content. Its format 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.", "type": "string", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "String" @@ -1407,131 +1533,41 @@ "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" - } - }, - "required": [ - "stdOrganization", - "msgType", - "msgEncodeFormat", - "msgContent" - ], - "type": "object", - "x-etsi-notes": "NOTE 1: Other standardization organizations could be added as needed.NOTE 2:The 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" - }, - "V2xMsgSubscription.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" - }, - "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 2.", - "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 1.", - "enum": ["ETSI"], + "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": "string", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "Enum" - } - }, - "required": ["stdOrganization"], - "type": "object", - "x-etsi-mec-cardinality": "1" - }, - "V2xMsgSubscription": { - "properties": { - "_links": { - "$ref": "#/components/schemas/V2xMsgSubscription.links" }, - "callbackReference": { - "description": "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.", - "format": "uri", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "URI" - }, - "expiryDeadline": { - "$ref": "#/components/schemas/TimeStamp" - }, - "filterCriteria": { - "$ref": "#/components/schemas/V2xMsgSubscription.filterCriteria" - }, - "subscriptionType": { - "description": "Shall be set to \"V2xMsgSubscription\".", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" - } - }, - "required": ["subscriptionType", "callbackReference", "filterCriteria"], - "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.3.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": "0..1" - }, - "V2xMsgNotification": { - "properties": { "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" - }, "stdOrganization": { - "description": "Standardization organization which defines the published V2X message type ETSI: European Telecommunications Standards Institute. See note 1.", + "description": "Standardization organization which defines the published V2X message type: \nETSI: European Telecommunications Standards Institute.\nSee note 1.", "enum": ["ETSI"], - "type": "string" - }, - "msgType": { - "$ref": "#/components/schemas/msgType" - }, - "msgEncodeFormat": { - "description": "The encode format of the V2X message, for example base64 ", - "type": "string" - }, - "msgContent": { - "description": "Published V2X message content. The format of the string is defined by the standardization organization indicated by the attribute stdOrganization.", - "type": "string" + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Enum" }, - "_links": { - "$ref": "#/components/schemas/V2xMsgNotification.links" + "timeStamp": { + "$ref": "#/components/schemas/TimeStamp" } }, "required": [ @@ -1544,58 +1580,155 @@ "_links" ], "type": "object", - "x-etsi-notes": "NOTE 1: Other standardization organizations could be added as needed. NOTE 2: The V2X message types of ETSI shall be used as specified in ETSI TS 102 894-2 [6], clause A.114" + "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" }, - "V2xServerUsd.sdpInfo": { - "description": "SDP with IP multicast address and port number used for V2X communication via MBMS.", + "V2xMsgPublication": { "properties": { - "ipMulticastAddress": { - "description": "", + "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" }, - "portNumber": { - "description": "", + "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": { + "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": "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": ["ETSI"], + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Enum" } }, - "required": ["ipMulticastAddress", "portNumber"], + "required": [ + "stdOrganization", + "msgType", + "msgEncodeFormat", + "msgContent" + ], "type": "object", - "x-etsi-mec-cardinality": "1" + "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" }, - "V2xServerUsd.tmgi": { - "description": "Temporary Mobile Group Identity (TMGI), which is used within MBMS to uniquely identify Multicast and Broadcast bearer services.", + "V2xMsgSubscription": { "properties": { - "mbmsServiceId": { - "description": "MBMS Service ID consisting of three octets.", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" + "_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)" }, - "mcc": { - "description": "The Mobile Country Code part of PLMN Identity.", + "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": { + "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": "String" + "x-etsi-mec-origin-type": "Structure (inlined)" }, - "mnc": { - "description": "The Mobile Network Code part of PLMN Identity.", + "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": ["mbmsServiceId", "mcc", "mnc"], + "required": ["subscriptionType", "filterCriteria"], "type": "object", - "x-etsi-mec-cardinality": "" + "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" }, "V2xServerUsd": { "properties": { "sdpInfo": { - "$ref": "#/components/schemas/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)" }, "serviceAreaIdentifier": { "description": "A list of service area identifier for the applicable MBMS broadcast area.", @@ -1608,65 +1741,55 @@ "x-etsi-mec-origin-type": "String" }, "tmgi": { - "$ref": "#/components/schemas/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)" } }, "required": ["tmgi", "serviceAreaIdentifier", "sdpInfo"], "type": "object", "x-etsi-ref": "6.5.10" }, - "LinkType": { - "description": "'This data type represents a type of link'", - "type": "object", - "required": ["href"], - "properties": { - "href": { - "$ref": "#/components/schemas/Href" - } - } - }, - "Href": { - "description": "The URI referring to the subscription.", - "type": "string", - "format": "uri" - }, - "ProblemDetails": { + "WebsockNotifConfig": { "properties": { - "detail": { - "description": "A human-readable explanation specific to this occurrence of the problem", - "type": "string", + "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": "String" + "x-etsi-mec-origin-type": "Boolean" }, - "instance": { - "description": "A URI reference that identifies the specific occurrence of the problem", + "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" - }, - "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" + "x-etsi-mec-origin-type": "Uri" } }, - "type": "object" + "type": "object", + "x-etsi-ref": "6.5.14" } }, "responses": { diff --git a/MEC030_V2XInformationService.yaml b/MEC030_V2XInformationService.yaml index de75b99..850b08f 100644 --- a/MEC030_V2XInformationService.yaml +++ b/MEC030_V2XInformationService.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: 'ETSI GS MEC 030 V2X Information Service API' - version: 2.1.1 + version: 2.2.1 description: 'ETSI GS MEC 030 V2X Information Service API described using OpenAPI.' contact: name: ETSI Forge @@ -11,15 +11,17 @@ info: name: BSD-3-Clause url: 'https://forge.etsi.org/legal-matters' externalDocs: - description: 'ETSI GS MEC 030 V2X Information Service API, v2.1.1' - url: 'https://www.etsi.org/deliver/etsi_gs/MEC/001_099/030/02.01.01_60/gs_mec030v020101p.pdf' + description: 'ETSI GS MEC 030 V2X Information Service API, v2.2.1' + url: 'https://www.etsi.org/deliver/etsi_gs/MEC/001_099/030/02.02.01_60/gs_mec030v020201p.pdf' servers: - - url: 'https://localhost/vis/v1' + - 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: @@ -463,28 +465,18 @@ components: - dlTransmissionBandwidth type: object x-etsi-ref: 6.5.6 - - LocationInfo.geoArea: - description: Information of a geographical area. + LinkType: 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 + href: + description: URI referring to a resource + format: uri + type: string x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Float + x-etsi-mec-origin-type: Uri required: - - latitude - - longitude + - href type: object - x-etsi-mec-cardinality: 0..1 - + x-etsi-ref: 6.5.13 LocationInfo: properties: ecgi: @@ -493,7 +485,26 @@ components: # x-etsi-mec-origin-type': Ecgi $ref: '#/components/schemas/Ecgi' geoArea: - $ref: '#/components/schemas/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) type: object x-etsi-notes: "NOTE:\tEither ecgi or geoArea shall be present, but not both." x-etsi-ref: 6.5.3 @@ -510,59 +521,59 @@ components: # x-etsi-mec-origin-type': Plmn $ref: '#/components/schemas/Plmn' siV2xConfig: - description: V2X sidelink communication configuration, as defined in ETSI TS 136 331 [i.11]. + # description': V2X sidelink communication configuration, as defined in ETSI TS 136 331 [i.11]. # x-etsi-mec-cardinality': '1' # x-etsi-mec-origin-type': SystemInformationBlockType21 (as defined in ETSI TS 136 331 [i.11]) - type: string + $ref: '#/components/schemas/SystemInformationBlockType21' required: - plmn - ecgi - siV2xConfig type: object x-etsi-ref: 6.5.12 - - Pc5ProvisioningInfo.proInfoPc5: - description: The provisioning information per location as defined below. - - 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 Layer-2 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: - # description': Location information to identify a cell of a base station or a particular geographical area. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': 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 - Pc5ProvisioningInfo: - properties: - proInfoPc5: - type: array - items: - $ref: '#/components/schemas/Pc5ProvisioningInfo.proInfoPc5' - timeStamp: - # description': Time stamp. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': TimeStamp - $ref: '#/components/schemas/TimeStamp' + items: + properties: + proInfoPc5: + description: The provisioning information per location as defined below. + items: + type: object + minItems: 1 + 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: + # description': Location information to identify a cell of a base station or a particular geographical area. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': 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: array + x-etsi-mec-cardinality: 1..N + x-etsi-mec-origin-type: Structure (inlined) + timeStamp: + # description': Time stamp. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': TimeStamp + $ref: '#/components/schemas/TimeStamp' + type: object required: - proInfoPc5 type: object x-etsi-ref: 6.2.4 - Plmn: properties: mcc: @@ -580,54 +591,107 @@ components: - mnc type: object x-etsi-ref: 6.5.4 - - PredictedQos.routes.routeInfo: - required: - - location - properties: - location: - $ref: '#/components/schemas/LocationInfo' - time: - $ref: '#/components/schemas/TimeStamp' - rsrp: - description: 'Reference Signal Received Quality as defined in ETSI TS 136 214 [i.13]. Shall only be included in the response' - type: integer - format: Uint8 - - rsrq: - description: 'Reference Signal Received Quality as defined in ETSI TS 136 214 [i.13]. Shall only be included in the response' - type: integer - format: Uint8 - - PredictedQos.routes: - properties: - 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. ' - type: array - minItems: 2 - items: - $ref: '#/components/schemas/PredictedQos.routes.routeInfo' - required: - - routeinfo - PredictedQos: - description: 'predicted QoS of a vehicular UE' properties: - timeGranularity: - $ref: '#/components/schemas/TimeStamp' locationGranularity: - description: 'Granularity of visited location. Measured in meters' + description: Granularity of visited location. Measured in meters. type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String routes: - type: array + description: Information relating to the potential routes of a vehicular UE. items: - $ref: '#/components/schemas/PredictedQos.routes' + properties: + 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.' + items: + type: object + minItems: 2 + properties: + location: + # description': Vehicular UE location. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': LocationInfo + $ref: '#/components/schemas/LocationInfo' + rsrp: + description: + 'Reference Signal Received Power as defined in ETSI TS 136 214 [i.13]. + + Shall 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]. + + Shall only be included in the response.' + format: uint8 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint8 + 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: array + x-etsi-mec-cardinality: 2..N + x-etsi-mec-origin-type: Structure (inlined) + type: object + minItems: 1 + required: + - routeInfo + 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 type: object - x-etsi-mec-cardinality: 0..1 - + 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 + 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: @@ -663,73 +727,79 @@ components: - locationInfo type: object x-etsi-ref: 6.4.4 - - ProvChgPc5Subscription.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 - - 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: - # description': Location information to identify a cell of a base station or a particular geographical area. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': 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' ProvChgPc5Subscription: properties: _links: - $ref: '#/components/schemas/ProvChgPc5Subscription.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) callbackReference: - description: 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. + description: URI exposed by the client on which to receive notifications via HTTP. See note. format: uri type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: URI + 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: - $ref: '#/components/schemas/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: + # description': Location information to identify a cell of a base station or a particular geographical area. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': 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) + 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: + # 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 - - callbackReference - 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 ProvChgUuMbmsNotification: properties: @@ -766,73 +836,79 @@ components: - locationInfo type: object x-etsi-ref: 6.4.3 - ProvChgUuMbmsSubscription.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 - - 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: - # description': Location information to identify a cell of a base station or a particular geographical area. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': 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: - # description': User Service Description for V2X Application Server is used to configure the UE for receiving local V2X Application Server information when it is provided over MBMS. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': V2xServerUsd - $ref: '#/components/schemas/V2xServerUsd' - required: - - locationInfo - - v2xServerUsd - type: object - x-etsi-mec-cardinality: '1' - ProvChgUuMbmsSubscription: properties: _links: - $ref: '#/components/schemas/ProvChgUuMbmsSubscription.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) callbackReference: - description: 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. + description: URI exposed by the client on which to receive notifications via HTTP. See note. format: uri type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: URI + 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: - $ref: '#/components/schemas/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: + # description': Location information to identify a cell of a base station or a particular geographical area. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': 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: + # description': User Service Description for V2X Application Server is used to configure the UE for receiving local V2X Application Server information when it is provided over MBMS. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': V2xServerUsd + $ref: '#/components/schemas/V2xServerUsd' + required: + - locationInfo + - v2xServerUsd + type: object + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Structure (inlined) + 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: + # 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 - - callbackReference - 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 ProvChgUuUniNotification: properties: @@ -869,120 +945,126 @@ components: - locationInfo type: object x-etsi-ref: 6.4.2 - ProvChgUuUniSubscription.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 - - 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: - # description': Location information to identify a cell of a base station or a particular geographical area. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': 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: - # description': V2X Application Server address (consisting of IP address and UDP port) for unicast. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': V2xApplicationServer - $ref: '#/components/schemas/V2xApplicationServer' - required: - - locationInfo - - v2xApplicationServer - type: object - x-etsi-mec-cardinality: '1' - ProvChgUuUniSubscription: properties: _links: - $ref: '#/components/schemas/ProvChgUuUniSubscription.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) callbackReference: - description: 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. + description: URI exposed by the client on which to receive notifications via HTTP. See note. format: uri type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: URI + 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: - $ref: '#/components/schemas/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: + # description': Location information to identify a cell of a base station or a particular geographical area. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': 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: + # description': V2X Application Server address (consisting of IP address and UDP port) for unicast. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': V2xApplicationServer + $ref: '#/components/schemas/V2xApplicationServer' + required: + - locationInfo + - v2xApplicationServer + type: object + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Structure (inlined) + 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: + # 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 - - callbackReference - 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 - - SubscriptionLinkList.links.subscriptions: - description: "The service consumer\u2019s subscriptions." - 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 - - 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' - type: object - required: - - self - x-etsi-mec-cardinality: '1' - SubscriptionLinkList: properties: _links: - $ref: '#/components/schemas/SubscriptionLinkList.links' + description: List of hyperlinks related to the resource. + items: + properties: + self: + # description': URI of this resource. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': LinkType + $ref: '#/components/schemas/LinkType' + subscriptions: + description: The service consumer's subscriptions. + items: + 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 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: Structure (inlined) + type: object + required: + - self + type: object + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Structure (inlined) required: - _links type: object x-etsi-ref: 6.3.6 - + SystemInformationBlockType21: + type: object TddInfo: properties: earfcn: @@ -1006,17 +1088,42 @@ components: - subframeAssignment type: object x-etsi-ref: 6.5.7 + TestNotification: + properties: + _links: + description: 'Hyperlink related to the resource. ' + properties: + subscription: + # description': URI identifying the subscription for the test notification. + # 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) + 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 + 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 + format: uint32 type: integer x-etsi-mec-cardinality: '1' x-etsi-mec-origin-type: Uint32 @@ -1025,23 +1132,33 @@ components: - nanoSeconds type: object x-etsi-ref: 6.5.2 - TransmissionBandwidth.transmissionBandwidth: - description: 'Numeric value corresponding to the transmission bandwidth expressed in units of resource blocks as follows:1 = bw6 (6 resource blocks)2 = bw15 (15 resource blocks) 3 = bw25 (25 resource blocks) 4 = bw50 (50 resource blocks) 5 = bw75 (75 resource blocks) 6 = bw100 (100 resource blocks)' - enum: - - 1 - - 2 - - 3 - - 4 - - 5 - - 6 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Enum - TransmissionBandwidth: properties: transmissionBandwidth: - $ref: '#/components/schemas/TransmissionBandwidth.transmissionBandwidth' + description: | + 'Numeric value corresponding to the transmission bandwidth expressed in units of resource blocks as follows: + + 1 = bw6 (6 resource blocks) + + 2 = bw15 (15 resource blocks) + + 3 = bw25 (25 resource blocks) + + 4 = bw50 (50 resource blocks) + + 5 = bw75 (75 resource blocks) + + 6 = bw100 (100 resource blocks)' + enum: + - '1' + - '2' + - '3' + - '4' + - '5' + - '6' + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Enum required: - transmissionBandwidth type: object @@ -1090,47 +1207,49 @@ components: - mbmsServiceAreaIdentity type: object x-etsi-ref: 6.5.11 - - UuMbmsProvisioningInfo.proInfoUuMbms: - description: The provisioning information per location as defined below. - properties: - locationInfo: - # description': Location information to identify a cell of a base station or a particular geographical area. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': LocationInfo - $ref: '#/components/schemas/LocationInfo' - neighbourCellInfo: - description: The information of the neighbour cells in a visiting PLMN that support V2X communication over Uu MBMS. - type: array - items: - $ref: '#/components/schemas/UuMbmsNeighbourCellInfo' - minItems: 0 - - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: UuMbmsNeighbourCellInfo - v2xServerUsd: - # description': User Service Description for V2X Application Server is used to configure the UE for receiving local V2X Application Server information when it is provided over MBMS. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': V2xServerUsd - $ref: '#/components/schemas/V2xServerUsd' - required: - - locationInfo - - v2xServerUsd - UuMbmsProvisioningInfo: - properties: - proInfoUuMbms: - $ref: '#/components/schemas/UuMbmsProvisioningInfo.proInfoUuMbms' - timeStamp: - # description': Time stamp. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': TimeStamp - $ref: '#/components/schemas/TimeStamp' + items: + properties: + proInfoUuMbms: + description: The provisioning information per location as defined below. + items: + type: object + minItems: 1 + properties: + locationInfo: + # description': Location information to identify a cell of a base station or a particular geographical area. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': 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: + # description': User Service Description for V2X Application Server is used to configure the UE for receiving local V2X Application Server information when it is provided over MBMS. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': V2xServerUsd + $ref: '#/components/schemas/V2xServerUsd' + required: + - locationInfo + - v2xServerUsd + type: array + x-etsi-mec-cardinality: 1..N + x-etsi-mec-origin-type: Structure (inlined) + timeStamp: + # description': Time stamp. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': TimeStamp + $ref: '#/components/schemas/TimeStamp' + type: object required: - proInfoUuMbms type: object x-etsi-ref: 6.2.3 - UuUniNeighbourCellInfo: properties: ecgi: @@ -1166,43 +1285,45 @@ components: - tddInfo type: object x-etsi-ref: 6.5.9 - - UuUnicastProvisioningInfo.proInfoUuUnicast: - description: The provisioning information per location as defined below. - properties: - locationInfo: - # description': Location information to identify a cell of a base station or a particular geographical area. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': 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: - # description': V2X Application Server address (consisting of IP address and UDP port) for unicast. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': V2xApplicationServer - $ref: '#/components/schemas/V2xApplicationServer' - required: - - locationInfo - - v2xApplicationServer - x-etsi-mec-cardinality: 1..N UuUnicastProvisioningInfo: - properties: - proInfoUuUnicast: - type: array - items: - $ref: '#/components/schemas/UuUnicastProvisioningInfo.proInfoUuUnicast' - timeStamp: - # description': Time stamp. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': TimeStamp - $ref: '#/components/schemas/TimeStamp' + items: + properties: + proInfoUuUnicast: + description: The provisioning information per location as defined below. + items: + type: object + minItems: 1 + properties: + locationInfo: + # description': Location information to identify a cell of a base station or a particular geographical area. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': 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: + # description': V2X Application Server address (consisting of IP address and UDP port) for unicast. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': V2xApplicationServer + $ref: '#/components/schemas/V2xApplicationServer' + required: + - locationInfo + - v2xApplicationServer + type: array + x-etsi-mec-cardinality: 1..N + x-etsi-mec-origin-type: Structure (inlined) + timeStamp: + # description': Time stamp. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': TimeStamp + $ref: '#/components/schemas/TimeStamp' + type: object required: - proInfoUuUnicast type: object @@ -1224,25 +1345,23 @@ components: - udpPort type: object x-etsi-ref: 6.5.8 - - msgType: - description: '− denm(1): Decentralized Environmental Notification Message (DENM) as specified in ETSI EN 302 637-3 [i.3], − cam(2): Cooperative Awareness Message (CAM) as specified in ETSI EN 302 637-2 [i.2], − poi(3): Point of Interest message as specified in ETSI TS 101 556-1 [i.11], − spat(4): Signal Phase And Timing (SPAT) message as specified in SAE J2735 [i.12], − map(5): MAP message as specified in SAE J2735 [i.12], − ivi(6): In Vehicle Information (IVI) message as defined in ISO TS 19321 [i.13], − ev-rsr(7): Electric vehicle recharging spot reservation message, as defined in ETSI TS 101 556-3 [i.14], ' - enum: - - 1 - - 2 - - 3 - - 4 - - 5 - - 6 - - 7 - type: integer - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Enum - - V2xMsgPublication: + V2xMsgNotification: properties: + _links: + 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) msgContent: - description: Published V2X message content. Its format 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. type: string x-etsi-mec-cardinality: '1' x-etsi-mec-origin-type: String @@ -1252,50 +1371,113 @@ components: x-etsi-mec-cardinality: '1' x-etsi-mec-origin-type: String msgType: - $ref: '#/components/schemas/msgType' - #x-etsi-mec-origin-type: Enum + description: | + Published V2X message type. Its value is defined by the standardization organization indicated by the attribute stdOrganization. See note 2. + − denm(1): Decentralized Environmental Notification Message (DENM) as specified in ETSI EN 302 637-3, + − cam(2): Cooperative Awareness Message (CAM) as specified in ETSI EN 302 637-2, + − poi(3): Point of Interest message as specified in ETSI TS 101 556-1, + − spatem(4): Signal Phase And Timing (SPAT) message as specified in SAE J2735 and in ETSI TS 103 301, + − mapem(5): MAP message as specified in SAE J2735 and in ETSI TS 103 301, + − ivim(6): In Vehicle Information (IVI) message as defined in ISO TS 19321, + − ev-rsr(7): Electric vehicle recharging spot reservation message, as defined in ETSI TS 101 556-3, + − tistpgtransaction(8): messages for Tyre Information System (TIS) and Tyre Pressure Gauge (TPG) interoperability, as specified in ETSI TS 101 556-2, + − srem(9): Traffic light Signal Request Message as specified in ETSI TS 103 301, + − ssem(10): Traffic Light Signal Request Status Message as specified in ETSI TS 103 301. + − evcsn(11): Electrical Vehicle Charging Spot Notification message as specified in ETSI TS 101 556-1, + − saem(12): Services Announcement Extended Message as specified in ETSI TS 102 890-1, + − rtcmem(13): Radio Technical Commission for Maritime Services (RTCM) Message as specified in ETSI TS 103 301, + enum: + - '1' + - '2' + - '3' + - '4' + - '5' + - '6' + - '7' + - '8' + - '9' + - '10' + - '11' + - '12' + - '13' + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Enum + 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." + 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' - #-etsi-mec-origin-type: Enum + 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 type: object - x-etsi-notes: 'NOTE 1: Other standardization organizations could be added as needed.NOTE 2:The 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 - - V2xMsgSubscription.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 - - 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. + 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 + 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: - description: Subscribed V2X message type. Its value is defined by the standardization organization indicated by the attribute stdOrganization. See note 2. - items: - type: string - minItems: 0 - type: array - x-etsi-mec-cardinality: 0..N + description: | + Published V2X message type. Its value is defined by the standardization organization indicated by the attribute stdOrganization. See note 2. + − denm(1): Decentralized Environmental Notification Message (DENM) as specified in ETSI EN 302 637-3, + − cam(2): Cooperative Awareness Message (CAM) as specified in ETSI EN 302 637-2, + − poi(3): Point of Interest message as specified in ETSI TS 101 556-1, + − spatem(4): Signal Phase And Timing (SPAT) message as specified in SAE J2735 and in ETSI TS 103 301, + − mapem(5): MAP message as specified in SAE J2735 and in ETSI TS 103 301, + − ivim(6): In Vehicle Information (IVI) message as defined in ISO TS 19321, + − ev-rsr(7): Electric vehicle recharging spot reservation message, as defined in ETSI TS 101 556-3, + − tistpgtransaction(8): messages for Tyre Information System (TIS) and Tyre Pressure Gauge (TPG) interoperability, as specified in ETSI TS 101 556-2, + − srem(9): Traffic light Signal Request Message as specified in ETSI TS 103 301, + − ssem(10): Traffic Light Signal Request Status Message as specified in ETSI TS 103 301. + − evcsn(11): Electrical Vehicle Charging Spot Notification message as specified in ETSI TS 101 556-1, + − saem(12): Services Announcement Extended Message as specified in ETSI TS 102 890-1, + − rtcmem(13): Radio Technical Commission for Maritime Services (RTCM) Message as specified in ETSI TS 103 301, + enum: + - '1' + - '2' + - '3' + - '4' + - '5' + - '6' + - '7' + - '8' + - '9' + - '10' + - '11' + - '12' + - '13' + type: string + x-etsi-mec-cardinality: '1' x-etsi-mec-origin-type: Enum stdOrganization: - description: "Standardization organization which defines the subscribed V2X message type: \nETSI: European Telecommunications Standards Institute. \nSee note 1." + description: "Standardization organization which defines the published V2X message type:\nETSI: European Telecommunications Standards Institute. \nSee note 1." enum: - ETSI type: string @@ -1303,137 +1485,103 @@ components: x-etsi-mec-origin-type: Enum required: - stdOrganization + - msgType + - msgEncodeFormat + - msgContent type: object - x-etsi-mec-cardinality: '1' - + 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 V2xMsgSubscription: properties: _links: - $ref: '#/components/schemas/V2xMsgSubscription.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) callbackReference: - description: 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. + description: URI exposed by the client on which to receive notifications via HTTP. See note 1. format: uri type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: URI + 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: - $ref: '#/components/schemas/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) + 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: + # description': Provides details to negotiate and signal the use of a Websocket connection between VIS and the service consumer for notifications. See note 1. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': WebsockNotifConfig + $ref: '#/components/schemas/WebsockNotifConfig' required: - subscriptionType - - callbackReference - filterCriteria 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-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 - - V2xMsgNotification.links: - description: 'Links to resources related to this notification.' - properties: - subscription: - # 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: - - subscription - type: object - x-etsi-mec-cardinality: 0..1 - - V2xMsgNotification: - properties: - notificationType: - description: Shall be set to "V2xMsgNotification". - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String - timeStamp: - # description': Time stamp. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': TimeStamp - $ref: '#/components/schemas/TimeStamp' - stdOrganization: - description: 'Standardization organization which defines the published V2X message type ETSI: European Telecommunications Standards Institute. See note 1.' - enum: - - 'ETSI' - type: string - msgType: - $ref: '#/components/schemas/msgType' - msgEncodeFormat: - description: 'The encode format of the V2X message, for example base64 ' - type: string - msgContent: - description: 'Published V2X message content. The format of the string is defined by the standardization organization indicated by the attribute stdOrganization.' - type: string - _links: - $ref: '#/components/schemas/V2xMsgNotification.links' - required: - - notificationType - - timeStamp - - stdOrganization - - msgType - - msgEncodeFormat - - msgContent - - _links - type: object - x-etsi-notes: 'NOTE 1: Other standardization organizations could be added as needed. NOTE 2: The V2X message types of ETSI shall be used as specified in ETSI TS 102 894-2 [6], clause A.114' - - 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' - 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: '' - V2xServerUsd: properties: sdpInfo: - $ref: '#/components/schemas/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) serviceAreaIdentifier: description: A list of service area identifier for the applicable MBMS broadcast area. items: @@ -1443,59 +1591,52 @@ components: x-etsi-mec-cardinality: 1..N x-etsi-mec-origin-type: String tmgi: - $ref: '#/components/schemas/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) required: - tmgi - serviceAreaIdentifier - sdpInfo type: object x-etsi-ref: 6.5.10 - - LinkType: - description: >- - 'This data type represents a type of link' - type: object - required: - - href - properties: - href: - $ref: '#/components/schemas/Href' - Href: - description: >- - The URI referring to the subscription. - type: string - format: uri - ProblemDetails: + WebsockNotifConfig: 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 + 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: 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 + 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 + x-etsi-mec-origin-type: Uri type: object + x-etsi-ref: 6.5.14 + responses: '204': description: No Content -- GitLab From 3ef125f86065271df407355a37c2f7b8cd7217cf Mon Sep 17 00:00:00 2001 From: "M. Rehan Abbasi" Date: Fri, 18 Feb 2022 12:55:35 +0500 Subject: [PATCH 3/6] separate data models for nested objects --- MEC030_V2XInformationService.json | 851 +++++++++++++-------------- MEC030_V2XInformationService.yaml | 938 +++++++++++++++--------------- 2 files changed, 885 insertions(+), 904 deletions(-) diff --git a/MEC030_V2XInformationService.json b/MEC030_V2XInformationService.json index 929a9e8..88eb274 100644 --- a/MEC030_V2XInformationService.json +++ b/MEC030_V2XInformationService.json @@ -666,6 +666,18 @@ "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": { @@ -686,33 +698,36 @@ "$ref": "#/components/schemas/Ecgi" }, "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)" + "$ref": "#/components/schemas/GeoArea" } }, "type": "object", "x-etsi-notes": "NOTE:\tEither ecgi or geoArea shall be present, but not both.", "x-etsi-ref": "6.5.3" }, + "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": { @@ -733,36 +748,7 @@ "items": { "properties": { "proInfoPc5": { - "description": "The provisioning information per location as defined below.", - "items": { - "type": "object" - }, - "minItems": 1, - "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"], - "type": "array", - "x-etsi-mec-cardinality": "1..N", - "x-etsi-mec-origin-type": "Structure (inlined)" + "$ref": "#/components/schemas/ProInfoPc5" }, "timeStamp": { "$ref": "#/components/schemas/TimeStamp" @@ -774,6 +760,38 @@ "type": "object", "x-etsi-ref": "6.2.4" }, + "ProInfoPc5": { + "description": "The provisioning information per location as defined below.", + "items": { + "type": "object" + }, + "minItems": 1, + "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"], + "type": "array", + "x-etsi-mec-cardinality": "1..N", + "x-etsi-mec-origin-type": "Structure (inlined)" + }, "Plmn": { "properties": { "mcc": { @@ -802,50 +820,7 @@ "x-etsi-mec-origin-type": "String" }, "routes": { - "description": "Information relating to the potential routes of a vehicular UE.", - "items": { - "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": { - "type": "object" - }, - "minItems": 2, - "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" - } - }, - "required": ["location"], - "type": "array", - "x-etsi-mec-cardinality": "2..N", - "x-etsi-mec-origin-type": "Structure (inlined)" - } - }, - "type": "object" - }, - "minItems": 1, - "required": ["routeInfo"], - "type": "array", - "x-etsi-mec-cardinality": "1..N", - "x-etsi-mec-origin-type": "Structure (inlined)" + "$ref": "#/components/schemas/Routes" }, "timeGranularity": { "$ref": "#/components/schemas/TimeStamp" @@ -856,6 +831,55 @@ "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" }, + "Routes": { + "description": "Information relating to the potential routes of a vehicular UE.", + "items": { + "properties": { + "routeInfo": { + "$ref": "#/components/schemas/RouteInfo" + } + }, + "type": "object" + }, + "minItems": 1, + "required": ["routeInfo"], + "type": "array", + "x-etsi-mec-cardinality": "1..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.", + "items": { + "type": "object" + }, + "minItems": 2, + "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" + } + }, + "required": ["location"], + "type": "array", + "x-etsi-mec-cardinality": "2..N", + "x-etsi-mec-origin-type": "Structure (inlined)" + }, "ProblemDetails": { "properties": { "detail": { @@ -932,16 +956,7 @@ "ProvChgPc5Subscription": { "properties": { "_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)" + "$ref": "#/components/schemas/Links" }, "callbackReference": { "description": "URI exposed by the client on which to receive notifications via HTTP. See note.", @@ -954,32 +969,7 @@ "$ref": "#/components/schemas/TimeStamp" }, "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)" + "$ref": "#/components/schemas/ProvChgPc5SubscriptionFilterCriteria" }, "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.", @@ -1002,6 +992,34 @@ "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" }, + "ProvChgPc5SubscriptionFilterCriteria": { + "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": { @@ -1037,16 +1055,7 @@ "ProvChgUuMbmsSubscription": { "properties": { "_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)" + "$ref": "#/components/schemas/Links" }, "callbackReference": { "description": "URI exposed by the client on which to receive notifications via HTTP. See note.", @@ -1059,29 +1068,7 @@ "$ref": "#/components/schemas/TimeStamp" }, "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)" + "$ref": "#/components/schemas/ProvChgUuMbmsSubscriptionFilterCriteria" }, "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.", @@ -1104,6 +1091,31 @@ "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" }, + "ProvChgUuMbmsSubscriptionFilterCriteria": { + "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": { @@ -1139,16 +1151,7 @@ "ProvChgUuUniSubscription": { "properties": { "_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)" + "$ref": "#/components/schemas/Links" }, "callbackReference": { "description": "URI exposed by the client on which to receive notifications via HTTP. See note.", @@ -1161,29 +1164,7 @@ "$ref": "#/components/schemas/TimeStamp" }, "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)" + "$ref": "#/components/schemas/ProvChgUuUniSubscriptionFilterCriteria" }, "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.", @@ -1206,48 +1187,35 @@ "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" }, - "SubscriptionLinkList": { + "ProvChgUuUniSubscriptionFilterCriteria": { + "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": { - "_links": { - "description": "List of hyperlinks related to the resource.", + "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": { - "properties": { - "self": { - "$ref": "#/components/schemas/LinkType" - }, - "subscriptions": { - "description": "The service consumer's subscriptions.", - "items": { - "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"], - "type": "array", - "x-etsi-mec-cardinality": "0..N", - "x-etsi-mec-origin-type": "Structure (inlined)" - } - }, - "type": "object" + "$ref": "#/components/schemas/UuUniNeighbourCellInfo" }, - "required": ["self"], - "type": "object", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Structure (inlined)" + "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/SubscriptionLinkListLinks" } }, "required": ["_links"], @@ -1276,6 +1244,50 @@ "type": "object", "x-etsi-ref": "6.5.7" }, + "SubscriptionLinkListLinks": { + "description": "List of hyperlinks related to the resource.", + "items": { + "properties": { + "self": { + "$ref": "#/components/schemas/LinkType" + }, + "subscriptions": { + "$ref": "#/components/schemas/SubscriptionLinkListLinksSubscriptions" + } + }, + "type": "object" + }, + "required": ["self"], + "type": "object", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Structure (inlined)" + }, + "SubscriptionLinkListLinksSubscriptions": { + "description": "The service consumer's subscriptions.", + "items": { + "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"], + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "Structure (inlined)" + }, "TestNotification": { "properties": { "_links": { @@ -1325,17 +1337,20 @@ "TransmissionBandwidth": { "properties": { "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": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Enum" + "$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": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Enum" + }, "UuMbmsNeighbourCellInfo": { "properties": { "ecgi": { @@ -1382,33 +1397,7 @@ "items": { "properties": { "proInfoUuMbms": { - "description": "The provisioning information per location as defined below.", - "items": { - "type": "object" - }, - "minItems": 1, - "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": "array", - "x-etsi-mec-cardinality": "1..N", - "x-etsi-mec-origin-type": "Structure (inlined)" + "$ref": "#/components/schemas/ProInfoUuMbms" }, "timeStamp": { "$ref": "#/components/schemas/TimeStamp" @@ -1420,6 +1409,35 @@ "type": "object", "x-etsi-ref": "6.2.3" }, + "ProInfoUuMbms": { + "description": "The provisioning information per location as defined below.", + "items": { + "type": "object" + }, + "minItems": 1, + "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": "array", + "x-etsi-mec-cardinality": "1..N", + "x-etsi-mec-origin-type": "Structure (inlined)" + }, "UuUniNeighbourCellInfo": { "properties": { "ecgi": { @@ -1449,33 +1467,7 @@ "items": { "properties": { "proInfoUuUnicast": { - "description": "The provisioning information per location as defined below.", - "items": { - "type": "object" - }, - "minItems": 1, - "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": "array", - "x-etsi-mec-cardinality": "1..N", - "x-etsi-mec-origin-type": "Structure (inlined)" + "$ref": "#/components/schemas/ProInfoUuUnicast" }, "timeStamp": { "$ref": "#/components/schemas/TimeStamp" @@ -1487,6 +1479,35 @@ "type": "object", "x-etsi-ref": "6.2.2" }, + "ProInfoUuUnicast": { + "description": "The provisioning information per location as defined below.", + "items": { + "type": "object" + }, + "minItems": 1, + "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": "array", + "x-etsi-mec-cardinality": "1..N", + "x-etsi-mec-origin-type": "Structure (inlined)" + }, "V2xApplicationServer": { "properties": { "ipAddress": { @@ -1509,16 +1530,7 @@ "V2xMsgNotification": { "properties": { "_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)" + "$ref": "#/components/schemas/V2xMsgNotificationLinks" }, "msgContent": { "description": "Published V2X message content. The format of the string is defined by the standardization organization indicated by the attribute stdOrganization.", @@ -1533,25 +1545,7 @@ "x-etsi-mec-origin-type": "String" }, "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": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Enum" + "$ref": "#/components/schemas/MsgType" }, "notificationType": { "description": "Shall be set to \"V2xMsgNotification\".", @@ -1583,6 +1577,18 @@ "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" }, + "V2xMsgNotificationLinks": { + "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": { @@ -1598,25 +1604,7 @@ "x-etsi-mec-origin-type": "String" }, "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": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "Enum" + "$ref": "#/components/schemas/MsgType" }, "stdOrganization": { "description": "Standardization organization which defines the published V2X message type:\nETSI: European Telecommunications Standards Institute. \nSee note 1.", @@ -1636,19 +1624,31 @@ "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": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Enum" + }, "V2xMsgSubscription": { "properties": { "_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)" + "$ref": "#/components/schemas/Links" }, "callbackReference": { "description": "URI exposed by the client on which to receive notifications via HTTP. See note 1.", @@ -1661,30 +1661,7 @@ "$ref": "#/components/schemas/TimeStamp" }, "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)" + "$ref": "#/components/schemas/V2xMsgSubscriptionFilterCriteria" }, "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.", @@ -1707,28 +1684,36 @@ "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" }, - "V2xServerUsd": { + "V2xMsgSubscriptionFilterCriteria": { + "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": { - "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" - } + "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" }, - "required": ["ipMulticastAddress", "portNumber"], - "type": "object", + "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": "Structure (inlined)" + "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/SdpInfo" }, "serviceAreaIdentifier": { "description": "A list of service area identifier for the applicable MBMS broadcast area.", @@ -1741,37 +1726,61 @@ "x-etsi-mec-origin-type": "String" }, "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)" + "$ref": "#/components/schemas/Tmgi" } }, "required": ["tmgi", "serviceAreaIdentifier", "sdpInfo"], "type": "object", "x-etsi-ref": "6.5.10" }, + "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)" + }, + "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": { diff --git a/MEC030_V2XInformationService.yaml b/MEC030_V2XInformationService.yaml index 850b08f..94ca159 100644 --- a/MEC030_V2XInformationService.yaml +++ b/MEC030_V2XInformationService.yaml @@ -465,6 +465,19 @@ 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. + # 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) LinkType: properties: href: @@ -485,29 +498,31 @@ components: # x-etsi-mec-origin-type': Ecgi $ref: '#/components/schemas/Ecgi' 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) + $ref: '#/components/schemas/GeoArea' type: object x-etsi-notes: "NOTE:\tEither ecgi or geoArea shall be present, but not both." x-etsi-ref: 6.5.3 + 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: @@ -535,35 +550,7 @@ components: items: properties: proInfoPc5: - description: The provisioning information per location as defined below. - items: - type: object - minItems: 1 - 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: - # description': Location information to identify a cell of a base station or a particular geographical area. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': 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: array - x-etsi-mec-cardinality: 1..N - x-etsi-mec-origin-type: Structure (inlined) + $ref: '#/components/schemas/ProInfoPc5' timeStamp: # description': Time stamp. # x-etsi-mec-cardinality': 0..1 @@ -574,6 +561,36 @@ components: - proInfoPc5 type: object x-etsi-ref: 6.2.4 + ProInfoPc5: + description: The provisioning information per location as defined below. + items: + type: object + minItems: 1 + 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: + # description': Location information to identify a cell of a base station or a particular geographical area. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': 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: array + x-etsi-mec-cardinality: 1..N + x-etsi-mec-origin-type: Structure (inlined) Plmn: properties: mcc: @@ -599,57 +616,7 @@ components: x-etsi-mec-cardinality: '1' x-etsi-mec-origin-type: String routes: - description: Information relating to the potential routes of a vehicular UE. - items: - properties: - 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.' - items: - type: object - minItems: 2 - properties: - location: - # description': Vehicular UE location. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': LocationInfo - $ref: '#/components/schemas/LocationInfo' - rsrp: - description: - 'Reference Signal Received Power as defined in ETSI TS 136 214 [i.13]. - - Shall 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]. - - Shall only be included in the response.' - format: uint8 - type: integer - x-etsi-mec-cardinality: 0..1 - x-etsi-mec-origin-type: Uint8 - 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: array - x-etsi-mec-cardinality: 2..N - x-etsi-mec-origin-type: Structure (inlined) - type: object - minItems: 1 - required: - - routeInfo - type: array - x-etsi-mec-cardinality: 1..N - x-etsi-mec-origin-type: Structure (inlined) + $ref: '#/components/schemas/Routes' timeGranularity: # description': Time granularity of visiting a location. # x-etsi-mec-cardinality': 0..1 @@ -661,6 +628,60 @@ components: 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 + Routes: + description: Information relating to the potential routes of a vehicular UE. + items: + properties: + routeInfo: + $ref: '#/components/schemas/RouteInfo' + type: object + minItems: 1 + required: + - routeInfo + type: array + x-etsi-mec-cardinality: 1..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.' + items: + type: object + minItems: 2 + properties: + location: + # description': Vehicular UE location. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': LocationInfo + $ref: '#/components/schemas/LocationInfo' + rsrp: + description: + 'Reference Signal Received Power as defined in ETSI TS 136 214 [i.13]. + + Shall 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]. + + Shall only be included in the response.' + format: uint8 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint8 + 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: array + x-etsi-mec-cardinality: 2..N + x-etsi-mec-origin-type: Structure (inlined) ProblemDetails: properties: detail: @@ -730,18 +751,7 @@ components: ProvChgPc5Subscription: properties: _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) + $ref: '#/components/schemas/Links' callbackReference: description: URI exposed by the client on which to receive notifications via HTTP. See note. format: uri @@ -754,32 +764,7 @@ components: # x-etsi-mec-origin-type': TimeStamp $ref: '#/components/schemas/TimeStamp' 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: - # description': Location information to identify a cell of a base station or a particular geographical area. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': 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) + $ref: '#/components/schemas/ProvChgPc5SubscriptionFilterCriteria' 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 @@ -801,6 +786,33 @@ components: 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 + ProvChgPc5SubscriptionFilterCriteria: + 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: + # description': Location information to identify a cell of a base station or a particular geographical area. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': 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: @@ -839,18 +851,7 @@ components: ProvChgUuMbmsSubscription: properties: _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) + $ref: '#/components/schemas/Links' callbackReference: description: URI exposed by the client on which to receive notifications via HTTP. See note. format: uri @@ -863,32 +864,7 @@ components: # x-etsi-mec-origin-type': TimeStamp $ref: '#/components/schemas/TimeStamp' 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: - # description': Location information to identify a cell of a base station or a particular geographical area. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': 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: - # description': User Service Description for V2X Application Server is used to configure the UE for receiving local V2X Application Server information when it is provided over MBMS. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': V2xServerUsd - $ref: '#/components/schemas/V2xServerUsd' - required: - - locationInfo - - v2xServerUsd - type: object - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Structure (inlined) + $ref: '#/components/schemas/ProvChgUuMbmsSubscriptionFilterCriteria' 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 @@ -910,6 +886,33 @@ components: 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 + ProvChgUuMbmsSubscriptionFilterCriteria: + 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: + # description': Location information to identify a cell of a base station or a particular geographical area. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': 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: + # description': User Service Description for V2X Application Server is used to configure the UE for receiving local V2X Application Server information when it is provided over MBMS. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': 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: @@ -948,18 +951,7 @@ components: ProvChgUuUniSubscription: properties: _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) + $ref: '#/components/schemas/Links' callbackReference: description: URI exposed by the client on which to receive notifications via HTTP. See note. format: uri @@ -972,32 +964,7 @@ components: # x-etsi-mec-origin-type': TimeStamp $ref: '#/components/schemas/TimeStamp' 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: - # description': Location information to identify a cell of a base station or a particular geographical area. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': 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: - # description': V2X Application Server address (consisting of IP address and UDP port) for unicast. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': V2xApplicationServer - $ref: '#/components/schemas/V2xApplicationServer' - required: - - locationInfo - - v2xApplicationServer - type: object - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Structure (inlined) + $ref: '#/components/schemas/ProvChgUuUniSubscriptionFilterCriteria' 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 @@ -1019,46 +986,37 @@ components: 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 + ProvChgUuUniSubscriptionFilterCriteria: + 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: + # description': Location information to identify a cell of a base station or a particular geographical area. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': 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: + # description': V2X Application Server address (consisting of IP address and UDP port) for unicast. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': 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: - description: List of hyperlinks related to the resource. - items: - properties: - self: - # description': URI of this resource. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': LinkType - $ref: '#/components/schemas/LinkType' - subscriptions: - description: The service consumer's subscriptions. - items: - 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 - type: array - x-etsi-mec-cardinality: 0..N - x-etsi-mec-origin-type: Structure (inlined) - type: object - required: - - self - type: object - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Structure (inlined) + $ref: '#/components/schemas/SubscriptionLinkListLinks' required: - _links type: object @@ -1088,6 +1046,46 @@ components: - subframeAssignment type: object x-etsi-ref: 6.5.7 + SubscriptionLinkListLinks: + description: List of hyperlinks related to the resource. + items: + properties: + self: + # description': URI of this resource. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': LinkType + $ref: '#/components/schemas/LinkType' + subscriptions: + $ref: '#/components/schemas/SubscriptionLinkListLinksSubscriptions' + type: object + required: + - self + type: object + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Structure (inlined) + SubscriptionLinkListLinksSubscriptions: + description: The service consumer's subscriptions. + items: + 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 + type: array + x-etsi-mec-cardinality: 0..N + x-etsi-mec-origin-type: Structure (inlined) TestNotification: properties: _links: @@ -1135,34 +1133,36 @@ components: TransmissionBandwidth: properties: transmissionBandwidth: - description: | - 'Numeric value corresponding to the transmission bandwidth expressed in units of resource blocks as follows: + $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: - 1 = bw6 (6 resource blocks) + 1 = bw6 (6 resource blocks) - 2 = bw15 (15 resource blocks) + 2 = bw15 (15 resource blocks) - 3 = bw25 (25 resource blocks) + 3 = bw25 (25 resource blocks) - 4 = bw50 (50 resource blocks) + 4 = bw50 (50 resource blocks) - 5 = bw75 (75 resource blocks) + 5 = bw75 (75 resource blocks) - 6 = bw100 (100 resource blocks)' - enum: - - '1' - - '2' - - '3' - - '4' - - '5' - - '6' - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Enum - required: - - transmissionBandwidth - type: object - x-etsi-ref: 6.6.4 + 6 = bw100 (100 resource blocks)' + enum: + - '1' + - '2' + - '3' + - '4' + - '5' + - '6' + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Enum UuMbmsNeighbourCellInfo: properties: ecgi: @@ -1211,35 +1211,7 @@ components: items: properties: proInfoUuMbms: - description: The provisioning information per location as defined below. - items: - type: object - minItems: 1 - properties: - locationInfo: - # description': Location information to identify a cell of a base station or a particular geographical area. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': 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: - # description': User Service Description for V2X Application Server is used to configure the UE for receiving local V2X Application Server information when it is provided over MBMS. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': V2xServerUsd - $ref: '#/components/schemas/V2xServerUsd' - required: - - locationInfo - - v2xServerUsd - type: array - x-etsi-mec-cardinality: 1..N - x-etsi-mec-origin-type: Structure (inlined) + $ref: '#/components/schemas/ProInfoUuMbms' timeStamp: # description': Time stamp. # x-etsi-mec-cardinality': 0..1 @@ -1250,6 +1222,36 @@ components: - proInfoUuMbms type: object x-etsi-ref: 6.2.3 + ProInfoUuMbms: + description: The provisioning information per location as defined below. + items: + type: object + minItems: 1 + properties: + locationInfo: + # description': Location information to identify a cell of a base station or a particular geographical area. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': 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: + # description': User Service Description for V2X Application Server is used to configure the UE for receiving local V2X Application Server information when it is provided over MBMS. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': V2xServerUsd + $ref: '#/components/schemas/V2xServerUsd' + required: + - locationInfo + - v2xServerUsd + type: array + x-etsi-mec-cardinality: 1..N + x-etsi-mec-origin-type: Structure (inlined) UuUniNeighbourCellInfo: properties: ecgi: @@ -1289,35 +1291,7 @@ components: items: properties: proInfoUuUnicast: - description: The provisioning information per location as defined below. - items: - type: object - minItems: 1 - properties: - locationInfo: - # description': Location information to identify a cell of a base station or a particular geographical area. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': 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: - # description': V2X Application Server address (consisting of IP address and UDP port) for unicast. - # x-etsi-mec-cardinality': '1' - # x-etsi-mec-origin-type': V2xApplicationServer - $ref: '#/components/schemas/V2xApplicationServer' - required: - - locationInfo - - v2xApplicationServer - type: array - x-etsi-mec-cardinality: 1..N - x-etsi-mec-origin-type: Structure (inlined) + $ref: '#/components/schemas/ProInfoUuUnicast' timeStamp: # description': Time stamp. # x-etsi-mec-cardinality': 0..1 @@ -1328,6 +1302,36 @@ components: - proInfoUuUnicast type: object x-etsi-ref: 6.2.2 + ProInfoUuUnicast: + description: The provisioning information per location as defined below. + items: + type: object + minItems: 1 + properties: + locationInfo: + # description': Location information to identify a cell of a base station or a particular geographical area. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': 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: + # description': V2X Application Server address (consisting of IP address and UDP port) for unicast. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': V2xApplicationServer + $ref: '#/components/schemas/V2xApplicationServer' + required: + - locationInfo + - v2xApplicationServer + type: array + x-etsi-mec-cardinality: 1..N + x-etsi-mec-origin-type: Structure (inlined) V2xApplicationServer: properties: ipAddress: @@ -1348,18 +1352,7 @@ components: V2xMsgNotification: properties: _links: - 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) + $ref: '#/components/schemas/V2xMsgNotificationLinks' msgContent: description: Published V2X message content. The format of the string is defined by the standardization organization indicated by the attribute stdOrganization. type: string @@ -1371,38 +1364,7 @@ components: x-etsi-mec-cardinality: '1' x-etsi-mec-origin-type: String msgType: - description: | - Published V2X message type. Its value is defined by the standardization organization indicated by the attribute stdOrganization. See note 2. - − denm(1): Decentralized Environmental Notification Message (DENM) as specified in ETSI EN 302 637-3, - − cam(2): Cooperative Awareness Message (CAM) as specified in ETSI EN 302 637-2, - − poi(3): Point of Interest message as specified in ETSI TS 101 556-1, - − spatem(4): Signal Phase And Timing (SPAT) message as specified in SAE J2735 and in ETSI TS 103 301, - − mapem(5): MAP message as specified in SAE J2735 and in ETSI TS 103 301, - − ivim(6): In Vehicle Information (IVI) message as defined in ISO TS 19321, - − ev-rsr(7): Electric vehicle recharging spot reservation message, as defined in ETSI TS 101 556-3, - − tistpgtransaction(8): messages for Tyre Information System (TIS) and Tyre Pressure Gauge (TPG) interoperability, as specified in ETSI TS 101 556-2, - − srem(9): Traffic light Signal Request Message as specified in ETSI TS 103 301, - − ssem(10): Traffic Light Signal Request Status Message as specified in ETSI TS 103 301. - − evcsn(11): Electrical Vehicle Charging Spot Notification message as specified in ETSI TS 101 556-1, - − saem(12): Services Announcement Extended Message as specified in ETSI TS 102 890-1, - − rtcmem(13): Radio Technical Commission for Maritime Services (RTCM) Message as specified in ETSI TS 103 301, - enum: - - '1' - - '2' - - '3' - - '4' - - '5' - - '6' - - '7' - - '8' - - '9' - - '10' - - '11' - - '12' - - '13' - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Enum + $ref: '#/components/schemas/MsgType' notificationType: description: Shall be set to "V2xMsgNotification". type: string @@ -1431,6 +1393,19 @@ components: 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 + V2xMsgNotificationLinks: + 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) V2xMsgPublication: properties: msgContent: @@ -1444,38 +1419,7 @@ components: x-etsi-mec-cardinality: '1' x-etsi-mec-origin-type: String msgType: - description: | - Published V2X message type. Its value is defined by the standardization organization indicated by the attribute stdOrganization. See note 2. - − denm(1): Decentralized Environmental Notification Message (DENM) as specified in ETSI EN 302 637-3, - − cam(2): Cooperative Awareness Message (CAM) as specified in ETSI EN 302 637-2, - − poi(3): Point of Interest message as specified in ETSI TS 101 556-1, - − spatem(4): Signal Phase And Timing (SPAT) message as specified in SAE J2735 and in ETSI TS 103 301, - − mapem(5): MAP message as specified in SAE J2735 and in ETSI TS 103 301, - − ivim(6): In Vehicle Information (IVI) message as defined in ISO TS 19321, - − ev-rsr(7): Electric vehicle recharging spot reservation message, as defined in ETSI TS 101 556-3, - − tistpgtransaction(8): messages for Tyre Information System (TIS) and Tyre Pressure Gauge (TPG) interoperability, as specified in ETSI TS 101 556-2, - − srem(9): Traffic light Signal Request Message as specified in ETSI TS 103 301, - − ssem(10): Traffic Light Signal Request Status Message as specified in ETSI TS 103 301. - − evcsn(11): Electrical Vehicle Charging Spot Notification message as specified in ETSI TS 101 556-1, - − saem(12): Services Announcement Extended Message as specified in ETSI TS 102 890-1, - − rtcmem(13): Radio Technical Commission for Maritime Services (RTCM) Message as specified in ETSI TS 103 301, - enum: - - '1' - - '2' - - '3' - - '4' - - '5' - - '6' - - '7' - - '8' - - '9' - - '10' - - '11' - - '12' - - '13' - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: Enum + $ref: '#/components/schemas/MsgType' stdOrganization: description: "Standardization organization which defines the published V2X message type:\nETSI: European Telecommunications Standards Institute. \nSee note 1." enum: @@ -1491,21 +1435,43 @@ components: 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. + − denm(1): Decentralized Environmental Notification Message (DENM) as specified in ETSI EN 302 637-3, + − cam(2): Cooperative Awareness Message (CAM) as specified in ETSI EN 302 637-2, + − poi(3): Point of Interest message as specified in ETSI TS 101 556-1, + − spatem(4): Signal Phase And Timing (SPAT) message as specified in SAE J2735 and in ETSI TS 103 301, + − mapem(5): MAP message as specified in SAE J2735 and in ETSI TS 103 301, + − ivim(6): In Vehicle Information (IVI) message as defined in ISO TS 19321, + − ev-rsr(7): Electric vehicle recharging spot reservation message, as defined in ETSI TS 101 556-3, + − tistpgtransaction(8): messages for Tyre Information System (TIS) and Tyre Pressure Gauge (TPG) interoperability, as specified in ETSI TS 101 556-2, + − srem(9): Traffic light Signal Request Message as specified in ETSI TS 103 301, + − ssem(10): Traffic Light Signal Request Status Message as specified in ETSI TS 103 301. + − evcsn(11): Electrical Vehicle Charging Spot Notification message as specified in ETSI TS 101 556-1, + − saem(12): Services Announcement Extended Message as specified in ETSI TS 102 890-1, + − rtcmem(13): Radio Technical Commission for Maritime Services (RTCM) Message as specified in ETSI TS 103 301, + enum: + - '1' + - '2' + - '3' + - '4' + - '5' + - '6' + - '7' + - '8' + - '9' + - '10' + - '11' + - '12' + - '13' + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Enum V2xMsgSubscription: properties: _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) + $ref: '#/components/schemas/Links' callbackReference: description: URI exposed by the client on which to receive notifications via HTTP. See note 1. format: uri @@ -1518,28 +1484,7 @@ components: # x-etsi-mec-origin-type': TimeStamp $ref: '#/components/schemas/TimeStamp' 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) + $ref: '#/components/schemas/V2xMsgSubscriptionFilterCriteria' 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 @@ -1561,27 +1506,33 @@ components: 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 + V2xMsgSubscriptionFilterCriteria: + 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: - 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) + $ref: '#/components/schemas/SdpInfo' serviceAreaIdentifier: description: A list of service area identifier for the applicable MBMS broadcast area. items: @@ -1591,36 +1542,57 @@ components: x-etsi-mec-cardinality: 1..N x-etsi-mec-origin-type: String 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) + $ref: '#/components/schemas/Tmgi' required: - tmgi - serviceAreaIdentifier - sdpInfo type: object x-etsi-ref: 6.5.10 + 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) + 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: -- GitLab From ef4cef47b2bea3fa02df26f439438e02653c9330 Mon Sep 17 00:00:00 2001 From: "M. Rehan Abbasi" Date: Fri, 18 Feb 2022 15:27:52 +0500 Subject: [PATCH 4/6] rename custom data models --- MEC030_V2XInformationService.json | 127 +++++++++++++++--------------- MEC030_V2XInformationService.yaml | 125 ++++++++++++++--------------- 2 files changed, 127 insertions(+), 125 deletions(-) diff --git a/MEC030_V2XInformationService.json b/MEC030_V2XInformationService.json index 88eb274..dc65095 100644 --- a/MEC030_V2XInformationService.json +++ b/MEC030_V2XInformationService.json @@ -666,7 +666,7 @@ "type": "object", "x-etsi-ref": "6.5.6" }, - "Links": { + "links": { "description": "Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.", "properties": { "self": { @@ -698,14 +698,14 @@ "$ref": "#/components/schemas/Ecgi" }, "geoArea": { - "$ref": "#/components/schemas/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" }, - "GeoArea": { + "LocationInfo.geoArea": { "description": "Information of a geographical area.", "properties": { "latitude": { @@ -748,7 +748,7 @@ "items": { "properties": { "proInfoPc5": { - "$ref": "#/components/schemas/ProInfoPc5" + "$ref": "#/components/schemas/Pc5ProvisioningInfo.proInfoPc5" }, "timeStamp": { "$ref": "#/components/schemas/TimeStamp" @@ -760,7 +760,7 @@ "type": "object", "x-etsi-ref": "6.2.4" }, - "ProInfoPc5": { + "Pc5ProvisioningInfo.proInfoPc5": { "description": "The provisioning information per location as defined below.", "items": { "type": "object" @@ -820,7 +820,15 @@ "x-etsi-mec-origin-type": "String" }, "routes": { - "$ref": "#/components/schemas/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" @@ -831,28 +839,25 @@ "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" }, - "Routes": { - "description": "Information relating to the potential routes of a vehicular UE.", - "items": { - "properties": { - "routeInfo": { - "$ref": "#/components/schemas/RouteInfo" - } - }, - "type": "object" + "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)" + } }, - "minItems": 1, - "required": ["routeInfo"], - "type": "array", - "x-etsi-mec-cardinality": "1..N", - "x-etsi-mec-origin-type": "Structure (inlined)" + "type": "object", + "minItems": 1 }, - "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": { - "type": "object" - }, - "minItems": 2, + "PredictedQos.routes.routeInfo": { + "type": "object", "properties": { "location": { "$ref": "#/components/schemas/LocationInfo" @@ -874,11 +879,7 @@ "time": { "$ref": "#/components/schemas/TimeStamp" } - }, - "required": ["location"], - "type": "array", - "x-etsi-mec-cardinality": "2..N", - "x-etsi-mec-origin-type": "Structure (inlined)" + } }, "ProblemDetails": { "properties": { @@ -956,7 +957,7 @@ "ProvChgPc5Subscription": { "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.", @@ -969,7 +970,7 @@ "$ref": "#/components/schemas/TimeStamp" }, "filterCriteria": { - "$ref": "#/components/schemas/ProvChgPc5SubscriptionFilterCriteria" + "$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.", @@ -992,7 +993,7 @@ "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" }, - "ProvChgPc5SubscriptionFilterCriteria": { + "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": { @@ -1055,7 +1056,7 @@ "ProvChgUuMbmsSubscription": { "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.", @@ -1068,7 +1069,7 @@ "$ref": "#/components/schemas/TimeStamp" }, "filterCriteria": { - "$ref": "#/components/schemas/ProvChgUuMbmsSubscriptionFilterCriteria" + "$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.", @@ -1091,7 +1092,7 @@ "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" }, - "ProvChgUuMbmsSubscriptionFilterCriteria": { + "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": { @@ -1151,7 +1152,7 @@ "ProvChgUuUniSubscription": { "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.", @@ -1164,7 +1165,7 @@ "$ref": "#/components/schemas/TimeStamp" }, "filterCriteria": { - "$ref": "#/components/schemas/ProvChgUuUniSubscriptionFilterCriteria" + "$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.", @@ -1187,7 +1188,7 @@ "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" }, - "ProvChgUuUniSubscriptionFilterCriteria": { + "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": { @@ -1215,7 +1216,7 @@ "SubscriptionLinkList": { "properties": { "_links": { - "$ref": "#/components/schemas/SubscriptionLinkListLinks" + "$ref": "#/components/schemas/SubscriptionLinkList.links" } }, "required": ["_links"], @@ -1244,7 +1245,7 @@ "type": "object", "x-etsi-ref": "6.5.7" }, - "SubscriptionLinkListLinks": { + "SubscriptionLinkList.links": { "description": "List of hyperlinks related to the resource.", "items": { "properties": { @@ -1252,7 +1253,7 @@ "$ref": "#/components/schemas/LinkType" }, "subscriptions": { - "$ref": "#/components/schemas/SubscriptionLinkListLinksSubscriptions" + "$ref": "#/components/schemas/SubscriptionLinkList.links.subscriptions" } }, "type": "object" @@ -1262,7 +1263,7 @@ "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "Structure (inlined)" }, - "SubscriptionLinkListLinksSubscriptions": { + "SubscriptionLinkList.links.subscriptions": { "description": "The service consumer's subscriptions.", "items": { "type": "object" @@ -1337,14 +1338,14 @@ "TransmissionBandwidth": { "properties": { "transmissionBandwidth": { - "$ref": "#/components/schemas/TransmissionBandwidth_transmissionBandwidth" + "$ref": "#/components/schemas/TransmissionBandwidth.transmissionBandwidth" } }, "required": ["transmissionBandwidth"], "type": "object", "x-etsi-ref": "6.6.4" }, - "TransmissionBandwidth_transmissionBandwidth": { + "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": "string", @@ -1397,7 +1398,7 @@ "items": { "properties": { "proInfoUuMbms": { - "$ref": "#/components/schemas/ProInfoUuMbms" + "$ref": "#/components/schemas/UuMbmsProvisioningInfo.proInfoUuMbms" }, "timeStamp": { "$ref": "#/components/schemas/TimeStamp" @@ -1409,7 +1410,7 @@ "type": "object", "x-etsi-ref": "6.2.3" }, - "ProInfoUuMbms": { + "UuMbmsProvisioningInfo.proInfoUuMbms": { "description": "The provisioning information per location as defined below.", "items": { "type": "object" @@ -1467,7 +1468,7 @@ "items": { "properties": { "proInfoUuUnicast": { - "$ref": "#/components/schemas/ProInfoUuUnicast" + "$ref": "#/components/schemas/UuUnicastProvisioningInfo.proInfoUuUnicast" }, "timeStamp": { "$ref": "#/components/schemas/TimeStamp" @@ -1479,7 +1480,7 @@ "type": "object", "x-etsi-ref": "6.2.2" }, - "ProInfoUuUnicast": { + "UuUnicastProvisioningInfo.proInfoUuUnicast": { "description": "The provisioning information per location as defined below.", "items": { "type": "object" @@ -1530,7 +1531,7 @@ "V2xMsgNotification": { "properties": { "_links": { - "$ref": "#/components/schemas/V2xMsgNotificationLinks" + "$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.", @@ -1545,7 +1546,7 @@ "x-etsi-mec-origin-type": "String" }, "msgType": { - "$ref": "#/components/schemas/MsgType" + "$ref": "#/components/schemas/msgType" }, "notificationType": { "description": "Shall be set to \"V2xMsgNotification\".", @@ -1577,8 +1578,8 @@ "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" }, - "V2xMsgNotificationLinks": { - "description": "Links to resources related to this notification.", + "V2xMsgNotification.links": { + "description": "links to resources related to this notification.", "properties": { "subscription": { "$ref": "#/components/schemas/LinkType" @@ -1604,7 +1605,7 @@ "x-etsi-mec-origin-type": "String" }, "msgType": { - "$ref": "#/components/schemas/MsgType" + "$ref": "#/components/schemas/msgType" }, "stdOrganization": { "description": "Standardization organization which defines the published V2X message type:\nETSI: European Telecommunications Standards Institute. \nSee note 1.", @@ -1624,7 +1625,7 @@ "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": { + "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", @@ -1648,7 +1649,7 @@ "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.", @@ -1661,7 +1662,7 @@ "$ref": "#/components/schemas/TimeStamp" }, "filterCriteria": { - "$ref": "#/components/schemas/V2xMsgSubscriptionFilterCriteria" + "$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.", @@ -1684,7 +1685,7 @@ "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" }, - "V2xMsgSubscriptionFilterCriteria": { + "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": { @@ -1713,7 +1714,7 @@ "V2xServerUsd": { "properties": { "sdpInfo": { - "$ref": "#/components/schemas/SdpInfo" + "$ref": "#/components/schemas/V2xServerUsd.sdpInfo" }, "serviceAreaIdentifier": { "description": "A list of service area identifier for the applicable MBMS broadcast area.", @@ -1726,14 +1727,14 @@ "x-etsi-mec-origin-type": "String" }, "tmgi": { - "$ref": "#/components/schemas/Tmgi" + "$ref": "#/components/schemas/V2xServerUsd.tmgi" } }, "required": ["tmgi", "serviceAreaIdentifier", "sdpInfo"], "type": "object", "x-etsi-ref": "6.5.10" }, - "SdpInfo": { + "V2xServerUsd.sdpInfo": { "description": "SDP with IP multicast address and port number used for V2X communication via MBMS.", "properties": { "ipMulticastAddress": { @@ -1754,7 +1755,7 @@ "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "Structure (inlined)" }, - "Tmgi": { + "V2xServerUsd.tmgi": { "description": "Temporary Mobile Group Identity (TMGI), which is used within MBMS to uniquely identify Multicast and Broadcast bearer services.", "properties": { "mbmsServiceId": { diff --git a/MEC030_V2XInformationService.yaml b/MEC030_V2XInformationService.yaml index 94ca159..6f3a54e 100644 --- a/MEC030_V2XInformationService.yaml +++ b/MEC030_V2XInformationService.yaml @@ -465,7 +465,7 @@ components: - dlTransmissionBandwidth type: object x-etsi-ref: 6.5.6 - Links: + links: description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests. properties: self: @@ -498,11 +498,11 @@ components: # x-etsi-mec-origin-type': Ecgi $ref: '#/components/schemas/Ecgi' geoArea: - $ref: '#/components/schemas/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 - GeoArea: + LocationInfo.geoArea: description: Information of a geographical area. properties: latitude: @@ -550,7 +550,7 @@ components: items: properties: proInfoPc5: - $ref: '#/components/schemas/ProInfoPc5' + $ref: '#/components/schemas/Pc5ProvisioningInfo.proInfoPc5' timeStamp: # description': Time stamp. # x-etsi-mec-cardinality': 0..1 @@ -561,7 +561,7 @@ components: - proInfoPc5 type: object x-etsi-ref: 6.2.4 - ProInfoPc5: + Pc5ProvisioningInfo.proInfoPc5: description: The provisioning information per location as defined below. items: type: object @@ -616,7 +616,15 @@ components: x-etsi-mec-cardinality: '1' x-etsi-mec-origin-type: String routes: - $ref: '#/components/schemas/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: # description': Time granularity of visiting a location. # x-etsi-mec-cardinality': 0..1 @@ -628,26 +636,24 @@ components: 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 - Routes: - description: Information relating to the potential routes of a vehicular UE. - items: - properties: - routeInfo: - $ref: '#/components/schemas/RouteInfo' - type: object - minItems: 1 - required: - - routeInfo - type: array - x-etsi-mec-cardinality: 1..N - x-etsi-mec-origin-type: Structure (inlined) - RouteInfo: - description: 'Information relating to a specific route. + PredictedQos.routes: + properties: + 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.' - items: - type: object - minItems: 2 + The 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: # description': Vehicular UE location. @@ -677,11 +683,6 @@ components: # x-etsi-mec-cardinality': 0..1 # x-etsi-mec-origin-type': TimeStamp $ref: '#/components/schemas/TimeStamp' - required: - - location - type: array - x-etsi-mec-cardinality: 2..N - x-etsi-mec-origin-type: Structure (inlined) ProblemDetails: properties: detail: @@ -751,7 +752,7 @@ components: ProvChgPc5Subscription: 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. format: uri @@ -764,7 +765,7 @@ components: # x-etsi-mec-origin-type': TimeStamp $ref: '#/components/schemas/TimeStamp' filterCriteria: - $ref: '#/components/schemas/ProvChgPc5SubscriptionFilterCriteria' + $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 @@ -786,7 +787,7 @@ components: 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 - ProvChgPc5SubscriptionFilterCriteria: + 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: @@ -851,7 +852,7 @@ components: ProvChgUuMbmsSubscription: 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. format: uri @@ -864,7 +865,7 @@ components: # x-etsi-mec-origin-type': TimeStamp $ref: '#/components/schemas/TimeStamp' filterCriteria: - $ref: '#/components/schemas/ProvChgUuMbmsSubscriptionFilterCriteria' + $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 @@ -886,7 +887,7 @@ components: 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 - ProvChgUuMbmsSubscriptionFilterCriteria: + 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: @@ -951,7 +952,7 @@ components: ProvChgUuUniSubscription: 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. format: uri @@ -964,7 +965,7 @@ components: # x-etsi-mec-origin-type': TimeStamp $ref: '#/components/schemas/TimeStamp' filterCriteria: - $ref: '#/components/schemas/ProvChgUuUniSubscriptionFilterCriteria' + $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 @@ -986,7 +987,7 @@ components: 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 - ProvChgUuUniSubscriptionFilterCriteria: + 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: @@ -1016,7 +1017,7 @@ components: SubscriptionLinkList: properties: _links: - $ref: '#/components/schemas/SubscriptionLinkListLinks' + $ref: '#/components/schemas/SubscriptionLinkList.links' required: - _links type: object @@ -1046,7 +1047,7 @@ components: - subframeAssignment type: object x-etsi-ref: 6.5.7 - SubscriptionLinkListLinks: + SubscriptionLinkList.links: description: List of hyperlinks related to the resource. items: properties: @@ -1056,14 +1057,14 @@ components: # x-etsi-mec-origin-type': LinkType $ref: '#/components/schemas/LinkType' subscriptions: - $ref: '#/components/schemas/SubscriptionLinkListLinksSubscriptions' + $ref: '#/components/schemas/SubscriptionLinkList.links.subscriptions' type: object required: - self type: object x-etsi-mec-cardinality: '1' x-etsi-mec-origin-type: Structure (inlined) - SubscriptionLinkListLinksSubscriptions: + SubscriptionLinkList.links.subscriptions: description: The service consumer's subscriptions. items: type: object @@ -1133,12 +1134,12 @@ components: TransmissionBandwidth: properties: transmissionBandwidth: - $ref: '#/components/schemas/TransmissionBandwidth_transmissionBandwidth' + $ref: '#/components/schemas/TransmissionBandwidth.transmissionBandwidth' required: - transmissionBandwidth type: object x-etsi-ref: 6.6.4 - TransmissionBandwidth_transmissionBandwidth: + TransmissionBandwidth.transmissionBandwidth: description: | 'Numeric value corresponding to the transmission bandwidth expressed in units of resource blocks as follows: @@ -1211,7 +1212,7 @@ components: items: properties: proInfoUuMbms: - $ref: '#/components/schemas/ProInfoUuMbms' + $ref: '#/components/schemas/UuMbmsProvisioningInfo.proInfoUuMbms' timeStamp: # description': Time stamp. # x-etsi-mec-cardinality': 0..1 @@ -1222,7 +1223,7 @@ components: - proInfoUuMbms type: object x-etsi-ref: 6.2.3 - ProInfoUuMbms: + UuMbmsProvisioningInfo.proInfoUuMbms: description: The provisioning information per location as defined below. items: type: object @@ -1291,7 +1292,7 @@ components: items: properties: proInfoUuUnicast: - $ref: '#/components/schemas/ProInfoUuUnicast' + $ref: '#/components/schemas/UuUnicastProvisioningInfo.proInfoUuUnicast' timeStamp: # description': Time stamp. # x-etsi-mec-cardinality': 0..1 @@ -1302,7 +1303,7 @@ components: - proInfoUuUnicast type: object x-etsi-ref: 6.2.2 - ProInfoUuUnicast: + UuUnicastProvisioningInfo.proInfoUuUnicast: description: The provisioning information per location as defined below. items: type: object @@ -1352,7 +1353,7 @@ components: V2xMsgNotification: properties: _links: - $ref: '#/components/schemas/V2xMsgNotificationLinks' + $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 @@ -1364,7 +1365,7 @@ components: x-etsi-mec-cardinality: '1' x-etsi-mec-origin-type: String msgType: - $ref: '#/components/schemas/MsgType' + $ref: '#/components/schemas/msgType' notificationType: description: Shall be set to "V2xMsgNotification". type: string @@ -1393,8 +1394,8 @@ components: 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 - V2xMsgNotificationLinks: - description: Links to resources related to this notification. + V2xMsgNotification.links: + description: links to resources related to this notification. properties: subscription: # description': A link to the related subscription. @@ -1419,7 +1420,7 @@ components: x-etsi-mec-cardinality: '1' x-etsi-mec-origin-type: String msgType: - $ref: '#/components/schemas/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: @@ -1435,7 +1436,7 @@ components: 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: + msgType: description: | Published V2X message type. Its value is defined by the standardization organization indicated by the attribute stdOrganization. See note 2. − denm(1): Decentralized Environmental Notification Message (DENM) as specified in ETSI EN 302 637-3, @@ -1471,7 +1472,7 @@ components: 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. format: uri @@ -1484,7 +1485,7 @@ components: # x-etsi-mec-origin-type': TimeStamp $ref: '#/components/schemas/TimeStamp' filterCriteria: - $ref: '#/components/schemas/V2xMsgSubscriptionFilterCriteria' + $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 @@ -1506,7 +1507,7 @@ components: 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 - V2xMsgSubscriptionFilterCriteria: + 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: @@ -1532,7 +1533,7 @@ components: V2xServerUsd: properties: sdpInfo: - $ref: '#/components/schemas/SdpInfo' + $ref: '#/components/schemas/V2xServerUsd.sdpInfo' serviceAreaIdentifier: description: A list of service area identifier for the applicable MBMS broadcast area. items: @@ -1542,14 +1543,14 @@ components: x-etsi-mec-cardinality: 1..N x-etsi-mec-origin-type: String tmgi: - $ref: '#/components/schemas/Tmgi' + $ref: '#/components/schemas/V2xServerUsd.tmgi' required: - tmgi - serviceAreaIdentifier - sdpInfo type: object x-etsi-ref: 6.5.10 - SdpInfo: + V2xServerUsd.sdpInfo: description: SDP with IP multicast address and port number used for V2X communication via MBMS. properties: ipMulticastAddress: @@ -1568,7 +1569,7 @@ components: type: object x-etsi-mec-cardinality: '1' x-etsi-mec-origin-type: Structure (inlined) - Tmgi: + V2xServerUsd.tmgi: description: Temporary Mobile Group Identity (TMGI), which is used within MBMS to uniquely identify Multicast and Broadcast bearer services. properties: mbmsServiceId: -- GitLab From 4956f60381919e5428b68764bff1c29201d2ea38 Mon Sep 17 00:00:00 2001 From: "M. Rehan Abbasi" Date: Thu, 3 Mar 2022 14:44:55 +0500 Subject: [PATCH 5/6] change enum type to integer where applicable --- MEC030_V2XInformationService.json | 4 +-- MEC030_V2XInformationService.yaml | 44 +++++++++++++++---------------- 2 files changed, 24 insertions(+), 24 deletions(-) diff --git a/MEC030_V2XInformationService.json b/MEC030_V2XInformationService.json index dc65095..5222b4a 100644 --- a/MEC030_V2XInformationService.json +++ b/MEC030_V2XInformationService.json @@ -1348,7 +1348,7 @@ "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": "string", + "type": "integer", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "Enum" }, @@ -1642,7 +1642,7 @@ "12", "13" ], - "type": "string", + "type": "integer", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "Enum" }, diff --git a/MEC030_V2XInformationService.yaml b/MEC030_V2XInformationService.yaml index 6f3a54e..40b32b5 100644 --- a/MEC030_V2XInformationService.yaml +++ b/MEC030_V2XInformationService.yaml @@ -1,4 +1,4 @@ -openapi: 3.1.0 +openapi: 3.0.0 info: title: 'ETSI GS MEC 030 V2X Information Service API' version: 2.2.1 @@ -1155,13 +1155,13 @@ components: 6 = bw100 (100 resource blocks)' enum: - - '1' - - '2' - - '3' - - '4' - - '5' - - '6' - type: string + - 1 + - 2 + - 3 + - 4 + - 5 + - 6 + type: integer x-etsi-mec-cardinality: '1' x-etsi-mec-origin-type: Enum UuMbmsNeighbourCellInfo: @@ -1453,20 +1453,20 @@ components: − saem(12): Services Announcement Extended Message as specified in ETSI TS 102 890-1, − rtcmem(13): Radio Technical Commission for Maritime Services (RTCM) Message as specified in ETSI TS 103 301, enum: - - '1' - - '2' - - '3' - - '4' - - '5' - - '6' - - '7' - - '8' - - '9' - - '10' - - '11' - - '12' - - '13' - type: string + - 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: -- GitLab From 9d7e2595e67036174c1acec91fc1b96a0aa6258c Mon Sep 17 00:00:00 2001 From: "M. Rehan Abbasi" Date: Mon, 14 Mar 2022 15:29:39 +0500 Subject: [PATCH 6/6] update specs version to 2.1.9 as per latest draft --- MEC030_V2XInformationService.json | 6 +++--- MEC030_V2XInformationService.yaml | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/MEC030_V2XInformationService.json b/MEC030_V2XInformationService.json index 5222b4a..ecb8644 100644 --- a/MEC030_V2XInformationService.json +++ b/MEC030_V2XInformationService.json @@ -2,7 +2,7 @@ "openapi": "3.1.0", "info": { "title": "ETSI GS MEC 030 V2X Information Service API", - "version": "2.2.1", + "version": "2.1.9", "description": "ETSI GS MEC 030 V2X Information Service API described using OpenAPI.", "contact": { "name": "ETSI Forge", @@ -15,8 +15,8 @@ } }, "externalDocs": { - "description": "ETSI GS MEC 030 V2X Information Service API, v2.2.1", - "url": "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/030/02.02.01_60/gs_mec030v020201p.pdf" + "description": "ETSI GS MEC 030 V2X Information Service API, v2.1.9", + "url": "" }, "servers": [ { diff --git a/MEC030_V2XInformationService.yaml b/MEC030_V2XInformationService.yaml index 40b32b5..d3b555c 100644 --- a/MEC030_V2XInformationService.yaml +++ b/MEC030_V2XInformationService.yaml @@ -1,7 +1,7 @@ openapi: 3.0.0 info: title: 'ETSI GS MEC 030 V2X Information Service API' - version: 2.2.1 + version: 2.1.9 description: 'ETSI GS MEC 030 V2X Information Service API described using OpenAPI.' contact: name: ETSI Forge @@ -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.2.1' - url: 'https://www.etsi.org/deliver/etsi_gs/MEC/001_099/030/02.02.01_60/gs_mec030v020201p.pdf' + description: 'ETSI GS MEC 030 V2X Information Service API, v2.1.9' + url: '' servers: - url: 'https://localhost/vis/v2' tags: -- GitLab