diff --git a/MEC030_V2XInformationService.json b/MEC030_V2XInformationService.json index 51311a980e5285f9735bec80bdbab8ed1d580bfd..ecb8644a6935d151b45390afb620a865a0ee3f42 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.1.9", "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.1.9", + "url": "" }, "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,31 @@ "type": "object", "x-etsi-ref": "6.5.6" }, - "LocationInfo.geoArea": { - "description": "Information of a geographical area.", + "links": { + "description": "Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.", "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", + "self": { + "$ref": "#/components/schemas/LinkType" + } + }, + "required": ["self"], + "type": "object", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Structure (inlined)" + }, + "LinkType": { + "properties": { + "href": { + "description": "URI referring to a resource", + "format": "uri", + "type": "string", "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "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": { @@ -695,6 +705,29 @@ "x-etsi-notes": "NOTE:\tEither ecgi or geoArea shall be present, but not both.", "x-etsi-ref": "6.5.3" }, + "LocationInfo.geoArea": { + "description": "Information of a geographical area.", + "properties": { + "latitude": { + "description": "Latitude (DATUM = WGS84) -90 to 90 in decimal degree format DDD.ddd", + "format": "float", + "type": "number", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Float" + }, + "longitude": { + "description": "Longitude (DATUM = WGS84) -180 to 180 in decimal degree format DDD.ddd", + "format": "float", + "type": "number", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Float" + } + }, + "required": ["latitude", "longitude"], + "type": "object", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Structure (inlined)" + }, "Pc5NeighbourCellInfo": { "properties": { "ecgi": { @@ -704,19 +737,38 @@ "$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": { + "items": { + "properties": { + "proInfoPc5": { + "$ref": "#/components/schemas/Pc5ProvisioningInfo.proInfoPc5" + }, + "timeStamp": { + "$ref": "#/components/schemas/TimeStamp" + } + }, + "type": "object" + }, + "required": ["proInfoPc5"], + "type": "object", + "x-etsi-ref": "6.2.4" + }, "Pc5ProvisioningInfo.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 Layer-2 ID(s) for different V2X services are configured in a consistent manner.", + "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" @@ -735,23 +787,10 @@ "x-etsi-mec-origin-type": "Pc5NeighbourCellInfo" } }, - "required": ["locationInfo", "dstLayer2Id"] - }, - "Pc5ProvisioningInfo": { - "properties": { - "proInfoPc5": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Pc5ProvisioningInfo.proInfoPc5" - } - }, - "timeStamp": { - "$ref": "#/components/schemas/TimeStamp" - } - }, - "required": ["proInfoPc5"], - "type": "object", - "x-etsi-ref": "6.2.4" + "required": ["locationInfo", "dstLayer2Id"], + "type": "array", + "x-etsi-mec-cardinality": "1..N", + "x-etsi-mec-origin-type": "Structure (inlined)" }, "Plmn": { "properties": { @@ -772,60 +811,113 @@ "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" + "locationGranularity": { + "description": "Granularity of visited location. Measured in meters.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" }, - "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" + "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)" }, - "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" + "timeGranularity": { + "$ref": "#/components/schemas/TimeStamp" } - } + }, + "required": ["locationGranularity", "routes"], + "type": "object", + "x-etsi-notes": "NOTE:\tThe data type of locationGranularity is a string which indicates the granularity of a visited location by means of latitudinal and longitudinal margins.", + "x-etsi-ref": "6.2.5" }, "PredictedQos.routes": { "properties": { - "routeinfo": { - "description": "Information relating to a specific route. 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, + "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)" } }, - "required": ["routeinfo"] + "type": "object", + "minItems": 1 }, - "PredictedQos": { - "description": "predicted QoS of a vehicular UE", + "PredictedQos.routes.routeInfo": { + "type": "object", "properties": { - "timeGranularity": { + "location": { + "$ref": "#/components/schemas/LocationInfo" + }, + "rsrp": { + "description": "Reference Signal Received Power as defined in ETSI TS 136 214 [i.13].\nShall only be included in the response.", + "format": "uint8", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint8" + }, + "rsrq": { + "description": "Reference Signal Received Quality as defined in ETSI TS 136 214 [i.13].\nShall only be included in the response.", + "format": "uint8", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint8" + }, + "time": { "$ref": "#/components/schemas/TimeStamp" + } + } + }, + "ProblemDetails": { + "properties": { + "detail": { + "description": "A human-readable explanation specific to this occurrence of the problem", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" }, - "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,16 +954,44 @@ "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.", + "ProvChgPc5Subscription": { "properties": { - "self": { - "$ref": "#/components/schemas/LinkType" + "_links": { + "$ref": "#/components/schemas/links" + }, + "callbackReference": { + "description": "URI exposed by the client on which to receive notifications via HTTP. See note.", + "format": "uri", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uri" + }, + "expiryDeadline": { + "$ref": "#/components/schemas/TimeStamp" + }, + "filterCriteria": { + "$ref": "#/components/schemas/ProvChgPc5Subscription.filterCriteria" + }, + "requestTestNotification": { + "description": "Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as described in ETSI GS MEC 009 [i.1], clause 6.12a.\nDefault: FALSE.", + "type": "boolean", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Boolean" + }, + "subscriptionType": { + "description": "Shall be set to \"ProvChgPc5Subscription\".", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "websockNotifConfig": { + "$ref": "#/components/schemas/WebsockNotifConfig" } }, - "required": ["self"], + "required": ["subscriptionType", "filterCriteria"], "type": "object", - "x-etsi-mec-cardinality": "0..1" + "x-etsi-notes": "NOTE: At least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to VIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009 [i.1], clause 6.12a.", + "x-etsi-ref": "6.3.4" }, "ProvChgPc5Subscription.filterCriteria": { "description": "List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response.", @@ -898,36 +1018,8 @@ }, "required": ["locationInfo", "dstLayer2Id"], "type": "object", - "x-etsi-mec-cardinality": "1" - }, - "ProvChgPc5Subscription": { - "properties": { - "_links": { - "$ref": "#/components/schemas/ProvChgPc5Subscription.links" - }, - "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.", - "format": "uri", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "URI" - }, - "expiryDeadline": { - "$ref": "#/components/schemas/TimeStamp" - }, - "filterCriteria": { - "$ref": "#/components/schemas/ProvChgPc5Subscription.filterCriteria" - }, - "subscriptionType": { - "description": "Shall be set to \"ProvChgPc5Subscription\".", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" - } - }, - "required": ["subscriptionType", "callbackReference", "filterCriteria"], - "type": "object", - "x-etsi-ref": "6.3.4" + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Structure (inlined)" }, "ProvChgUuMbmsNotification": { "properties": { @@ -961,16 +1053,44 @@ "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.", + "ProvChgUuMbmsSubscription": { "properties": { - "self": { - "$ref": "#/components/schemas/LinkType" + "_links": { + "$ref": "#/components/schemas/links" + }, + "callbackReference": { + "description": "URI exposed by the client on which to receive notifications via HTTP. See note.", + "format": "uri", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uri" + }, + "expiryDeadline": { + "$ref": "#/components/schemas/TimeStamp" + }, + "filterCriteria": { + "$ref": "#/components/schemas/ProvChgUuMbmsSubscription.filterCriteria" + }, + "requestTestNotification": { + "description": "Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as described in ETSI GS MEC 009 [i.1], clause 6.12a.\nDefault: FALSE.", + "type": "boolean", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Boolean" + }, + "subscriptionType": { + "description": "Shall be set to \"ProvChgUuMbmsSubscription\".", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "websockNotifConfig": { + "$ref": "#/components/schemas/WebsockNotifConfig" } }, - "required": ["self"], + "required": ["subscriptionType", "filterCriteria"], "type": "object", - "x-etsi-mec-cardinality": "0..1" + "x-etsi-notes": "NOTE:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to VIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009 [i.1], clause 6.12a.", + "x-etsi-ref": "6.3.3" }, "ProvChgUuMbmsSubscription.filterCriteria": { "description": "List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response.", @@ -994,38 +1114,10 @@ }, "required": ["locationInfo", "v2xServerUsd"], "type": "object", - "x-etsi-mec-cardinality": "1" + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Structure (inlined)" }, - "ProvChgUuMbmsSubscription": { - "properties": { - "_links": { - "$ref": "#/components/schemas/ProvChgUuMbmsSubscription.links" - }, - "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.", - "format": "uri", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "URI" - }, - "expiryDeadline": { - "$ref": "#/components/schemas/TimeStamp" - }, - "filterCriteria": { - "$ref": "#/components/schemas/ProvChgUuMbmsSubscription.filterCriteria" - }, - "subscriptionType": { - "description": "Shall be set to \"ProvChgUuMbmsSubscription\".", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "String" - } - }, - "required": ["subscriptionType", "callbackReference", "filterCriteria"], - "type": "object", - "x-etsi-ref": "6.3.3" - }, - "ProvChgUuUniNotification": { + "ProvChgUuUniNotification": { "properties": { "locationInfo": { "$ref": "#/components/schemas/LocationInfo" @@ -1057,16 +1149,44 @@ "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.", + "ProvChgUuUniSubscription": { "properties": { - "self": { - "$ref": "#/components/schemas/LinkType" + "_links": { + "$ref": "#/components/schemas/links" + }, + "callbackReference": { + "description": "URI exposed by the client on which to receive notifications via HTTP. See note.", + "format": "uri", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uri" + }, + "expiryDeadline": { + "$ref": "#/components/schemas/TimeStamp" + }, + "filterCriteria": { + "$ref": "#/components/schemas/ProvChgUuUniSubscription.filterCriteria" + }, + "requestTestNotification": { + "description": "Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as described in ETSI GS MEC 009 [i.1], clause 6.12a.\nDefault: FALSE.", + "type": "boolean", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Boolean" + }, + "subscriptionType": { + "description": "Shall be set to \"ProvChgUuUniSubscription\".", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "websockNotifConfig": { + "$ref": "#/components/schemas/WebsockNotifConfig" } }, - "required": ["self"], + "required": ["subscriptionType", "filterCriteria"], "type": "object", - "x-etsi-mec-cardinality": "0..1" + "x-etsi-notes": "NOTE:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to VIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009 [i.1], clause 6.12a.", + "x-etsi-ref": "6.3.2" }, "ProvChgUuUniSubscription.filterCriteria": { "description": "List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response.", @@ -1090,39 +1210,65 @@ }, "required": ["locationInfo", "v2xApplicationServer"], "type": "object", - "x-etsi-mec-cardinality": "1" + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Structure (inlined)" }, - "ProvChgUuUniSubscription": { + "SubscriptionLinkList": { "properties": { "_links": { - "$ref": "#/components/schemas/ProvChgUuUniSubscription.links" - }, - "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.", - "format": "uri", - "type": "string", - "x-etsi-mec-cardinality": "1", - "x-etsi-mec-origin-type": "URI" - }, - "expiryDeadline": { - "$ref": "#/components/schemas/TimeStamp" - }, - "filterCriteria": { - "$ref": "#/components/schemas/ProvChgUuUniSubscription.filterCriteria" + "$ref": "#/components/schemas/SubscriptionLinkList.links" + } + }, + "required": ["_links"], + "type": "object", + "x-etsi-ref": "6.3.6" + }, + "SystemInformationBlockType21": { + "type": "object" + }, + "TddInfo": { + "properties": { + "earfcn": { + "$ref": "#/components/schemas/Earfcn" }, - "subscriptionType": { - "description": "Shall be set to \"ProvChgUuUniSubscription\".", + "subframeAssignment": { + "description": "Uplink-downlink subframe configuration information.", "type": "string", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "String" + }, + "transmissionBandwidth": { + "$ref": "#/components/schemas/TransmissionBandwidth" } }, - "required": ["subscriptionType", "callbackReference", "filterCriteria"], + "required": ["earfcn", "transmissionBandwidth", "subframeAssignment"], "type": "object", - "x-etsi-ref": "6.3.2" + "x-etsi-ref": "6.5.7" + }, + "SubscriptionLinkList.links": { + "description": "List of hyperlinks related to the resource.", + "items": { + "properties": { + "self": { + "$ref": "#/components/schemas/LinkType" + }, + "subscriptions": { + "$ref": "#/components/schemas/SubscriptionLinkList.links.subscriptions" + } + }, + "type": "object" + }, + "required": ["self"], + "type": "object", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Structure (inlined)" }, "SubscriptionLinkList.links.subscriptions": { - "description": "The service consumer’s subscriptions.", + "description": "The service consumer's subscriptions.", + "items": { + "type": "object" + }, + "minItems": 0, "properties": { "href": { "description": "The URI referring to the subscription.", @@ -1132,73 +1278,54 @@ "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.", + "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" + "type": "array", + "x-etsi-mec-cardinality": "0..N", + "x-etsi-mec-origin-type": "Structure (inlined)" }, - "SubscriptionLinkList": { + "TestNotification": { "properties": { "_links": { - "$ref": "#/components/schemas/SubscriptionLinkList.links" - } - }, - "required": ["_links"], - "type": "object", - "x-etsi-ref": "6.3.6" - }, - "TddInfo": { - "properties": { - "earfcn": { - "$ref": "#/components/schemas/Earfcn" + "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)" }, - "subframeAssignment": { - "description": "Uplink-downlink subframe configuration information.", + "notificationType": { + "description": "Shall be set to \"TestNotification\".", "type": "string", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "String" - }, - "transmissionBandwidth": { - "$ref": "#/components/schemas/TransmissionBandwidth" } }, - "required": ["earfcn", "transmissionBandwidth", "subframeAssignment"], + "required": ["notificationType", "_links"], "type": "object", - "x-etsi-ref": "6.5.7" + "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,13 +1335,6 @@ "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": { @@ -1225,6 +1345,13 @@ "type": "object", "x-etsi-ref": "6.6.4" }, + "TransmissionBandwidth.transmissionBandwidth": { + "description": "'Numeric value corresponding to the transmission bandwidth expressed in units of resource blocks as follows:\n\n1 = bw6 (6 resource blocks)\n\n2 = bw15 (15 resource blocks)\n\n3 = bw25 (25 resource blocks)\n\n4 = bw50 (50 resource blocks)\n\n5 = bw75 (75 resource blocks)\n\n6 = bw100 (100 resource blocks)'\n", + "enum": ["1", "2", "3", "4", "5", "6"], + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Enum" + }, "UuMbmsNeighbourCellInfo": { "properties": { "ecgi": { @@ -1267,19 +1394,39 @@ "type": "object", "x-etsi-ref": "6.5.11" }, + "UuMbmsProvisioningInfo": { + "items": { + "properties": { + "proInfoUuMbms": { + "$ref": "#/components/schemas/UuMbmsProvisioningInfo.proInfoUuMbms" + }, + "timeStamp": { + "$ref": "#/components/schemas/TimeStamp" + } + }, + "type": "object" + }, + "required": ["proInfoUuMbms"], + "type": "object", + "x-etsi-ref": "6.2.3" + }, "UuMbmsProvisioningInfo.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.", - "type": "array", "items": { "$ref": "#/components/schemas/UuMbmsNeighbourCellInfo" }, "minItems": 0, + "type": "array", "x-etsi-mec-cardinality": "0..N", "x-etsi-mec-origin-type": "UuMbmsNeighbourCellInfo" }, @@ -1287,20 +1434,10 @@ "$ref": "#/components/schemas/V2xServerUsd" } }, - "required": ["locationInfo", "v2xServerUsd"] - }, - "UuMbmsProvisioningInfo": { - "properties": { - "proInfoUuMbms": { - "$ref": "#/components/schemas/UuMbmsProvisioningInfo.proInfoUuMbms" - }, - "timeStamp": { - "$ref": "#/components/schemas/TimeStamp" - } - }, - "required": ["proInfoUuMbms"], - "type": "object", - "x-etsi-ref": "6.2.3" + "required": ["locationInfo", "v2xServerUsd"], + "type": "array", + "x-etsi-mec-cardinality": "1..N", + "x-etsi-mec-origin-type": "Structure (inlined)" }, "UuUniNeighbourCellInfo": { "properties": { @@ -1327,8 +1464,28 @@ "type": "object", "x-etsi-ref": "6.5.9" }, + "UuUnicastProvisioningInfo": { + "items": { + "properties": { + "proInfoUuUnicast": { + "$ref": "#/components/schemas/UuUnicastProvisioningInfo.proInfoUuUnicast" + }, + "timeStamp": { + "$ref": "#/components/schemas/TimeStamp" + } + }, + "type": "object" + }, + "required": ["proInfoUuUnicast"], + "type": "object", + "x-etsi-ref": "6.2.2" + }, "UuUnicastProvisioningInfo.proInfoUuUnicast": { "description": "The provisioning information per location as defined below.", + "items": { + "type": "object" + }, + "minItems": 1, "properties": { "locationInfo": { "$ref": "#/components/schemas/LocationInfo" @@ -1348,23 +1505,9 @@ } }, "required": ["locationInfo", "v2xApplicationServer"], - "x-etsi-mec-cardinality": "1..N" - }, - "UuUnicastProvisioningInfo": { - "properties": { - "proInfoUuUnicast": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UuUnicastProvisioningInfo.proInfoUuUnicast" - } - }, - "timeStamp": { - "$ref": "#/components/schemas/TimeStamp" - } - }, - "required": ["proInfoUuUnicast"], - "type": "object", - "x-etsi-ref": "6.2.2" + "type": "array", + "x-etsi-mec-cardinality": "1..N", + "x-etsi-mec-origin-type": "Structure (inlined)" }, "V2xApplicationServer": { "properties": { @@ -1385,17 +1528,13 @@ "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": { + "$ref": "#/components/schemas/V2xMsgNotification.links" + }, "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" @@ -1409,70 +1548,115 @@ "msgType": { "$ref": "#/components/schemas/msgType" }, + "notificationType": { + "description": "Shall be set to \"V2xMsgNotification\".", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, "stdOrganization": { - "description": "Standardization organization which defines the published V2X message type: \nETSI: European Telecommunications Standards Institute. \nSee note 1.", + "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-cardinality": "1", + "x-etsi-mec-origin-type": "Enum" + }, + "timeStamp": { + "$ref": "#/components/schemas/TimeStamp" } }, "required": [ + "notificationType", + "timeStamp", "stdOrganization", "msgType", "msgEncodeFormat", - "msgContent" + "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" + "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" }, - "V2xMsgSubscription.links": { - "description": "Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.", + "V2xMsgNotification.links": { + "description": "links to resources related to this notification.", "properties": { - "self": { + "subscription": { "$ref": "#/components/schemas/LinkType" } }, - "required": ["self"], + "required": ["subscription"], "type": "object", - "x-etsi-mec-cardinality": "0..1" + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Structure (inlined)" }, - "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.", + "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", - "x-etsi-mec-origin-type": "Enum" + "$ref": "#/components/schemas/msgType" }, "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", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "Enum" } }, - "required": ["stdOrganization"], + "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" + }, + "msgType": { + "description": "Published V2X message type. Its value is defined by the standardization organization indicated by the attribute stdOrganization. See note 2.\n− denm(1): Decentralized Environmental Notification Message (DENM) as specified in ETSI EN 302 637-3,\n− cam(2): Cooperative Awareness Message (CAM) as specified in ETSI EN 302 637-2,\n− poi(3): Point of Interest message as specified in ETSI TS 101 556-1,\n− spatem(4): Signal Phase And Timing (SPAT) message as specified in SAE J2735 and in ETSI TS 103 301,\n− mapem(5): MAP message as specified in SAE J2735 and in ETSI TS 103 301,\n− ivim(6): In Vehicle Information (IVI) message as defined in ISO TS 19321,\n− ev-rsr(7): Electric vehicle recharging spot reservation message, as defined in ETSI TS 101 556-3,\n− tistpgtransaction(8): messages for Tyre Information System (TIS) and Tyre Pressure Gauge (TPG) interoperability, as specified in ETSI TS 101 556-2,\n− srem(9): Traffic light Signal Request Message as specified in ETSI TS 103 301,\n− ssem(10): Traffic Light Signal Request Status Message as specified in ETSI TS 103 301.\n− evcsn(11): Electrical Vehicle Charging Spot Notification message as specified in ETSI TS 101 556-1,\n− saem(12): Services Announcement Extended Message as specified in ETSI TS 102 890-1,\n− rtcmem(13): Radio Technical Commission for Maritime Services (RTCM) Message as specified in ETSI TS 103 301,\n", + "enum": [ + "1", + "2", + "3", + "4", + "5", + "6", + "7", + "8", + "9", + "10", + "11", + "12", + "13" + ], + "type": "integer", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Enum" }, "V2xMsgSubscription": { "properties": { "_links": { - "$ref": "#/components/schemas/V2xMsgSubscription.links" + "$ref": "#/components/schemas/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.", + "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": { "$ref": "#/components/schemas/TimeStamp" @@ -1480,71 +1664,75 @@ "filterCriteria": { "$ref": "#/components/schemas/V2xMsgSubscription.filterCriteria" }, + "requestTestNotification": { + "description": "Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as described in ETSI GS MEC 009 [i.1], clause 6.12a.\nDefault: FALSE.", + "type": "boolean", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Boolean" + }, "subscriptionType": { "description": "Shall be set to \"V2xMsgSubscription\".", "type": "string", "x-etsi-mec-cardinality": "1", "x-etsi-mec-origin-type": "String" + }, + "websockNotifConfig": { + "$ref": "#/components/schemas/WebsockNotifConfig" } }, - "required": ["subscriptionType", "callbackReference", "filterCriteria"], + "required": ["subscriptionType", "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.", + "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": { - "subscription": { - "$ref": "#/components/schemas/LinkType" + "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": ["subscription"], + "required": ["stdOrganization"], "type": "object", - "x-etsi-mec-cardinality": "0..1" + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Structure (inlined)" }, - "V2xMsgNotification": { + "V2xServerUsd": { "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.", - "enum": ["ETSI"], - "type": "string" - }, - "msgType": { - "$ref": "#/components/schemas/msgType" - }, - "msgEncodeFormat": { - "description": "The encode format of the V2X message, for example base64 ", - "type": "string" + "sdpInfo": { + "$ref": "#/components/schemas/V2xServerUsd.sdpInfo" }, - "msgContent": { - "description": "Published V2X message content. The format of the string is defined by the standardization organization indicated by the attribute stdOrganization.", - "type": "string" + "serviceAreaIdentifier": { + "description": "A list of service area identifier for the applicable MBMS broadcast area.", + "items": { + "type": "string" + }, + "minItems": 1, + "type": "array", + "x-etsi-mec-cardinality": "1..N", + "x-etsi-mec-origin-type": "String" }, - "_links": { - "$ref": "#/components/schemas/V2xMsgNotification.links" + "tmgi": { + "$ref": "#/components/schemas/V2xServerUsd.tmgi" } }, - "required": [ - "notificationType", - "timeStamp", - "stdOrganization", - "msgType", - "msgEncodeFormat", - "msgContent", - "_links" - ], + "required": ["tmgi", "serviceAreaIdentifier", "sdpInfo"], "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.5.10" }, "V2xServerUsd.sdpInfo": { "description": "SDP with IP multicast address and port number used for V2X communication via MBMS.", @@ -1564,7 +1752,8 @@ }, "required": ["ipMulticastAddress", "portNumber"], "type": "object", - "x-etsi-mec-cardinality": "1" + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Structure (inlined)" }, "V2xServerUsd.tmgi": { "description": "Temporary Mobile Group Identity (TMGI), which is used within MBMS to uniquely identify Multicast and Broadcast bearer services.", @@ -1590,83 +1779,27 @@ }, "required": ["mbmsServiceId", "mcc", "mnc"], "type": "object", - "x-etsi-mec-cardinality": "" - }, - "V2xServerUsd": { - "properties": { - "sdpInfo": { - "$ref": "#/components/schemas/V2xServerUsd.sdpInfo" - }, - "serviceAreaIdentifier": { - "description": "A list of service area identifier for the applicable MBMS broadcast area.", - "items": { - "type": "string" - }, - "minItems": 1, - "type": "array", - "x-etsi-mec-cardinality": "1..N", - "x-etsi-mec-origin-type": "String" - }, - "tmgi": { - "$ref": "#/components/schemas/V2xServerUsd.tmgi" - } - }, - "required": ["tmgi", "serviceAreaIdentifier", "sdpInfo"], - "type": "object", - "x-etsi-ref": "6.5.10" - }, - "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" + "x-etsi-mec-cardinality": "", + "x-etsi-mec-origin-type": "Structure (inlined)" }, - "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" - }, - "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" + "x-etsi-mec-origin-type": "Boolean" }, - "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", + "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" + "type": "object", + "x-etsi-ref": "6.5.14" } }, "responses": { diff --git a/MEC030_V2XInformationService.yaml b/MEC030_V2XInformationService.yaml index de75b99e5d0f17ccf8e4005b09ea37d83a65b3be..d3b555cb4417d8c6b3b86c414928bfc6803c69fb 100644 --- a/MEC030_V2XInformationService.yaml +++ b/MEC030_V2XInformationService.yaml @@ -1,7 +1,7 @@ -openapi: 3.1.0 +openapi: 3.0.0 info: title: 'ETSI GS MEC 030 V2X Information Service API' - version: 2.1.1 + version: 2.1.9 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.1.9' + url: '' 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,19 +465,55 @@ 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: + description: URI referring to a resource + format: uri + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Uri + required: + - href + type: object + x-etsi-ref: 6.5.13 + LocationInfo: + properties: + ecgi: + # description': E-UTRAN CelI Global Identifier of the serving cell. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': Ecgi + $ref: '#/components/schemas/Ecgi' + geoArea: + $ref: '#/components/schemas/LocationInfo.geoArea' + type: object + x-etsi-notes: "NOTE:\tEither ecgi or geoArea shall be present, but not both." + x-etsi-ref: 6.5.3 LocationInfo.geoArea: description: Information of a geographical area. properties: latitude: description: 'Latitude (DATUM = WGS84) -90 to 90 in decimal degree format DDD.ddd' - format: Float + 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 + 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 @@ -484,19 +522,7 @@ components: - longitude type: object x-etsi-mec-cardinality: 0..1 - - LocationInfo: - properties: - ecgi: - # description': E-UTRAN CelI Global Identifier of the serving cell. - # x-etsi-mec-cardinality': 0..1 - # x-etsi-mec-origin-type': Ecgi - $ref: '#/components/schemas/Ecgi' - geoArea: - $ref: '#/components/schemas/LocationInfo.geoArea' - type: object - x-etsi-notes: "NOTE:\tEither ecgi or geoArea shall be present, but not both." - x-etsi-ref: 6.5.3 + x-etsi-mec-origin-type: Structure (inlined) Pc5NeighbourCellInfo: properties: ecgi: @@ -510,23 +536,39 @@ 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: + items: + properties: + proInfoPc5: + $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' + type: object + required: + - proInfoPc5 + type: object + x-etsi-ref: 6.2.4 Pc5ProvisioningInfo.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 Layer-2 ID(s) for different V2X services are configured in a consistent manner." + 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 @@ -546,23 +588,9 @@ components: 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' - required: - - proInfoPc5 - type: object - x-etsi-ref: 6.2.4 - + type: array + x-etsi-mec-cardinality: 1..N + x-etsi-mec-origin-type: Structure (inlined) Plmn: properties: mcc: @@ -580,54 +608,112 @@ 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' + 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 + 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: + $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. + # 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' + 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,20 +749,44 @@ 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. + ProvChgPc5Subscription: 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' + _links: + $ref: '#/components/schemas/links' + callbackReference: + description: URI exposed by the client on which to receive notifications via HTTP. See note. + format: uri + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uri + expiryDeadline: + # 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' + 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: - - self + - subscriptionType + - filterCriteria type: object - x-etsi-mec-cardinality: 0..1 - + x-etsi-notes: 'NOTE: At least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to VIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009 [i.1], clause 6.12a.' + x-etsi-ref: 6.3.4 ProvChgPc5Subscription.filterCriteria: description: List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response. properties: @@ -703,34 +813,7 @@ components: - dstLayer2Id type: object x-etsi-mec-cardinality: '1' - ProvChgPc5Subscription: - properties: - _links: - $ref: '#/components/schemas/ProvChgPc5Subscription.links' - 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. - format: uri - type: string - x-etsi-mec-cardinality: '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' - subscriptionType: - description: Shall be set to "ProvChgPc5Subscription". - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String - required: - - subscriptionType - - callbackReference - - filterCriteria - type: object - x-etsi-ref: 6.3.4 + x-etsi-mec-origin-type: Structure (inlined) ProvChgUuMbmsNotification: properties: locationInfo: @@ -766,19 +849,44 @@ 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. + ProvChgUuMbmsSubscription: 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' + _links: + $ref: '#/components/schemas/links' + callbackReference: + description: URI exposed by the client on which to receive notifications via HTTP. See note. + format: uri + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uri + expiryDeadline: + # 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' + 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: - - self + - subscriptionType + - filterCriteria type: object - x-etsi-mec-cardinality: 0..1 - + x-etsi-notes: "NOTE:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to VIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009 [i.1], clause 6.12a." + x-etsi-ref: 6.3.3 ProvChgUuMbmsSubscription.filterCriteria: description: List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response. properties: @@ -805,35 +913,7 @@ components: - v2xServerUsd type: object x-etsi-mec-cardinality: '1' - - ProvChgUuMbmsSubscription: - properties: - _links: - $ref: '#/components/schemas/ProvChgUuMbmsSubscription.links' - 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. - format: uri - type: string - x-etsi-mec-cardinality: '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' - subscriptionType: - description: Shall be set to "ProvChgUuMbmsSubscription". - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String - required: - - subscriptionType - - callbackReference - - filterCriteria - type: object - x-etsi-ref: 6.3.3 + x-etsi-mec-origin-type: Structure (inlined) ProvChgUuUniNotification: properties: locationInfo: @@ -869,19 +949,44 @@ 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. + ProvChgUuUniSubscription: 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' + _links: + $ref: '#/components/schemas/links' + callbackReference: + description: URI exposed by the client on which to receive notifications via HTTP. See note. + format: uri + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uri + expiryDeadline: + # 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' + 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: - - self + - subscriptionType + - filterCriteria type: object - x-etsi-mec-cardinality: 0..1 - + x-etsi-notes: "NOTE:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to VIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009 [i.1], clause 6.12a." + x-etsi-ref: 6.3.2 ProvChgUuUniSubscription.filterCriteria: description: List of filtering criteria for the subscription. Any filtering criteria from below, which is included in the request, shall also be included in the response. properties: @@ -908,72 +1013,7 @@ components: - v2xApplicationServer type: object x-etsi-mec-cardinality: '1' - - ProvChgUuUniSubscription: - properties: - _links: - $ref: '#/components/schemas/ProvChgUuUniSubscription.links' - 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. - format: uri - type: string - x-etsi-mec-cardinality: '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' - subscriptionType: - description: Shall be set to "ProvChgUuUniSubscription". - type: string - x-etsi-mec-cardinality: '1' - x-etsi-mec-origin-type: String - required: - - subscriptionType - - callbackReference - - filterCriteria - type: object - 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' - + x-etsi-mec-origin-type: Structure (inlined) SubscriptionLinkList: properties: _links: @@ -982,7 +1022,8 @@ components: - _links type: object x-etsi-ref: 6.3.6 - + SystemInformationBlockType21: + type: object TddInfo: properties: earfcn: @@ -1006,17 +1047,82 @@ components: - subframeAssignment type: object x-etsi-ref: 6.5.7 + 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: + $ref: '#/components/schemas/SubscriptionLinkList.links.subscriptions' + type: object + required: + - self + type: object + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Structure (inlined) + SubscriptionLinkList.links.subscriptions: + description: The service consumer's subscriptions. + 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: + 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,8 +1131,29 @@ components: - nanoSeconds type: object x-etsi-ref: 6.5.2 + TransmissionBandwidth: + properties: + transmissionBandwidth: + $ref: '#/components/schemas/TransmissionBandwidth.transmissionBandwidth' + required: + - transmissionBandwidth + type: object + x-etsi-ref: 6.6.4 TransmissionBandwidth.transmissionBandwidth: - description: 'Numeric value corresponding to the transmission bandwidth expressed in units of resource blocks as follows: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)' + 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 @@ -1037,15 +1164,6 @@ components: type: integer x-etsi-mec-cardinality: '1' x-etsi-mec-origin-type: Enum - - TransmissionBandwidth: - properties: - transmissionBandwidth: - $ref: '#/components/schemas/TransmissionBandwidth.transmissionBandwidth' - required: - - transmissionBandwidth - type: object - x-etsi-ref: 6.6.4 UuMbmsNeighbourCellInfo: properties: ecgi: @@ -1089,10 +1207,27 @@ components: - tddInfo - mbmsServiceAreaIdentity type: object - x-etsi-ref: 6.5.11 - + x-etsi-ref: 6.5.11 + UuMbmsProvisioningInfo: + items: + 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' + type: object + required: + - proInfoUuMbms + type: object + x-etsi-ref: 6.2.3 UuMbmsProvisioningInfo.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. @@ -1101,11 +1236,10 @@ components: $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 - + type: array x-etsi-mec-cardinality: 0..N x-etsi-mec-origin-type: UuMbmsNeighbourCellInfo v2xServerUsd: @@ -1116,21 +1250,9 @@ components: 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' - required: - - proInfoUuMbms - type: object - x-etsi-ref: 6.2.3 - + type: array + x-etsi-mec-cardinality: 1..N + x-etsi-mec-origin-type: Structure (inlined) UuUniNeighbourCellInfo: properties: ecgi: @@ -1166,9 +1288,26 @@ components: - tddInfo type: object x-etsi-ref: 6.5.9 - + UuUnicastProvisioningInfo: + items: + properties: + proInfoUuUnicast: + $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' + type: object + required: + - proInfoUuUnicast + type: object + x-etsi-ref: 6.2.2 UuUnicastProvisioningInfo.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. @@ -1191,22 +1330,9 @@ components: required: - locationInfo - v2xApplicationServer + type: array 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' - required: - - proInfoUuUnicast - type: object - x-etsi-ref: 6.2.2 + x-etsi-mec-origin-type: Structure (inlined) V2xApplicationServer: properties: ipAddress: @@ -1224,25 +1350,12 @@ 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: + $ref: '#/components/schemas/V2xMsgNotification.links' 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 @@ -1253,49 +1366,63 @@ components: x-etsi-mec-origin-type: String msgType: $ref: '#/components/schemas/msgType' - #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. + x-etsi-notes: "NOTE 1:\tOther standardization organizations could be added as needed.\nNOTE 2:\tThe V2X message types of ETSI shall be used as specified in ETSI TS 102 894-2 [6], clause A.114." + x-etsi-ref: 6.4.5 + V2xMsgNotification.links: + description: links to resources related to this notification. properties: - self: - # description': Self-referring URI. The URI shall be unique within the VIS API as it acts as an ID for the subscription. + subscription: + # description': A link to the related subscription. # x-etsi-mec-cardinality': '1' # x-etsi-mec-origin-type': LinkType $ref: '#/components/schemas/LinkType' required: - - self + - subscription 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-mec-cardinality: '1' + x-etsi-mec-origin-type: Structure (inlined) + V2xMsgPublication: properties: + msgContent: + description: Published V2X message content. Its format is defined by the standardization organization indicated by the attribute stdOrganization. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + msgEncodeFormat: + description: The encode format of the V2X message, for example base64. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String msgType: - 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 + $ref: '#/components/schemas/msgType' 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,19 +1430,55 @@ components: x-etsi-mec-origin-type: Enum required: - stdOrganization + - msgType + - msgEncodeFormat + - msgContent type: object + x-etsi-notes: "NOTE 1:\tOther standardization organizations could be added as needed.\nNOTE 2:\tThe V2X message types of ETSI shall be used as specified in ETSI TS 102 894-2 [6], clause A.114." + x-etsi-ref: 6.2.6 + msgType: + description: | + Published V2X message type. Its value is defined by the standardization organization indicated by the attribute stdOrganization. See note 2. + − 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: integer x-etsi-mec-cardinality: '1' - + x-etsi-mec-origin-type: Enum V2xMsgSubscription: properties: _links: - $ref: '#/components/schemas/V2xMsgSubscription.links' + $ref: '#/components/schemas/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. + 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 @@ -1323,70 +1486,70 @@ components: $ref: '#/components/schemas/TimeStamp' filterCriteria: $ref: '#/components/schemas/V2xMsgSubscription.filterCriteria' + requestTestNotification: + description: "Shall be set to TRUE by the service consumer to request a test notification via HTTP on the callbackReference URI, as described in ETSI GS\_MEC 009 [i.1], clause 6.12a.\nDefault: FALSE." + type: boolean + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Boolean subscriptionType: description: Shall be set to "V2xMsgSubscription". type: string x-etsi-mec-cardinality: '1' x-etsi-mec-origin-type: String + websockNotifConfig: + # 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: + 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: - 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' + 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 published V2X message type ETSI: European Telecommunications Standards Institute. See note 1.' + description: "Standardization organization which defines the subscribed V2X message type: \nETSI: European Telecommunications Standards Institute. \nSee note 2." 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.' + - ETSI type: string - _links: - $ref: '#/components/schemas/V2xMsgNotification.links' + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Enum 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-mec-cardinality: '1' + x-etsi-mec-origin-type: Structure (inlined) + V2xServerUsd: + properties: + sdpInfo: + $ref: '#/components/schemas/V2xServerUsd.sdpInfo' + serviceAreaIdentifier: + description: A list of service area identifier for the applicable MBMS broadcast area. + items: + type: string + minItems: 1 + type: array + x-etsi-mec-cardinality: 1..N + x-etsi-mec-origin-type: String + tmgi: + $ref: '#/components/schemas/V2xServerUsd.tmgi' + required: + - tmgi + - serviceAreaIdentifier + - sdpInfo + type: object + x-etsi-ref: 6.5.10 V2xServerUsd.sdpInfo: description: SDP with IP multicast address and port number used for V2X communication via MBMS. properties: @@ -1405,6 +1568,7 @@ components: - portNumber type: object x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Structure (inlined) V2xServerUsd.tmgi: description: Temporary Mobile Group Identity (TMGI), which is used within MBMS to uniquely identify Multicast and Broadcast bearer services. properties: @@ -1429,73 +1593,23 @@ components: - mnc type: object x-etsi-mec-cardinality: '' - - V2xServerUsd: - properties: - sdpInfo: - $ref: '#/components/schemas/V2xServerUsd.sdpInfo' - serviceAreaIdentifier: - description: A list of service area identifier for the applicable MBMS broadcast area. - items: - type: string - minItems: 1 - type: array - x-etsi-mec-cardinality: 1..N - x-etsi-mec-origin-type: String - tmgi: - $ref: '#/components/schemas/V2xServerUsd.tmgi' - required: - - tmgi - - serviceAreaIdentifier - - sdpInfo - type: object - x-etsi-ref: 6.5.10 - - LinkType: - description: >- - 'This data type represents a type of link' - type: object - required: - - href + x-etsi-mec-origin-type: Structure (inlined) + WebsockNotifConfig: properties: - href: - $ref: '#/components/schemas/Href' - Href: - description: >- - The URI referring to the subscription. - type: string - format: uri - 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 + 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: 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 + 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 diff --git a/README.md b/README.md index 02f284b758587675a0fbfcc3e0cdeb2117edbc66..1741b116b7ba57416500f8b0d93ae37fd5f288ad 100644 --- a/README.md +++ b/README.md @@ -5,12 +5,12 @@ 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) +* [Specification document](https://www.etsi.org/deliver/etsi_gs/MEC/001_099/030/02.02.01_60/gs_MEC030v020201p.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/stf606-final/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-final/MEC030_V2XInformationService.yaml). -## License +## License Unless specified otherwise, the content of this repository and the files contained are released under the BSD-3-Clause license. See the attached LICENSE file or visit https://forge.etsi.org/legal-matters.