Skip to content
GitLab
Commits (6)
Show whitespace changes
Inline Side-by-side
MEC030_V2XInformationService.json
View file @ 6b02e98c
......@@ -18,13 +18,10 @@
"description": "ETSI GS MEC 030 V2X Information Service API, v2.1.9",
"url": ""
},
"servers": [
{
"servers": [{
"url": "https://localhost/vis/v2"
}
],
"tags": [
{
}],
"tags": [{
"name": "queries",
"description": "Queries"
},
......@@ -42,12 +39,13 @@
"paths": {
"/queries/uu_unicast_provisioning_info": {
"get": {
"tags": ["queries"],
"tags": [
"queries"
],
"summary": "Used to query provisioning information for V2X communication over Uu unicast.",
"description": "Used to query provisioning information for V2X communication over Uu unicast.",
"operationId": "prov_info_uu_unicastGET",
"parameters": [
{
"parameters": [{
"in": "query",
"name": "location_info",
"schema": {
......@@ -55,8 +53,7 @@
},
"required": true,
"description": "Comma separated list of locations to identify a cell of a base station or a particular geographical area"
}
],
}],
"responses": {
"200": {
"description": "A response body containing the Uu unicast provisioning information. ",
......@@ -91,12 +88,13 @@
},
"/queries/uu_mbms_provisioning_info": {
"get": {
"tags": ["queries"],
"tags": [
"queries"
],
"summary": "retrieve information required for V2X communication over Uu MBMS.",
"description": "retrieve information required for V2X communication over Uu MBMS.",
"operationId": "prov_info_uu_mbmsGET",
"parameters": [
{
"parameters": [{
"in": "query",
"name": "location_info",
"schema": {
......@@ -104,8 +102,7 @@
},
"required": true,
"description": "omma separated list of locations to identify a cell of a base station or a particular geographical area"
}
],
}],
"responses": {
"200": {
"description": "A response body containing the Uu unicast provisioning information. ",
......@@ -140,12 +137,13 @@
},
"/queries/pc5_provisioning_info": {
"get": {
"tags": ["queries"],
"tags": [
"queries"
],
"summary": "Query provisioning information for V2X communication over PC5.",
"description": "Query provisioning information for V2X communication over PC5.",
"operationId": "prov_infoGET",
"parameters": [
{
"parameters": [{
"in": "query",
"name": "location_info",
"schema": {
......@@ -153,8 +151,7 @@
},
"required": true,
"description": "Comma separated list of locations to identify a cell of a base station or a particular geographical area"
}
],
}],
"responses": {
"200": {
"description": "A response body containing the PC5 provisioning information is returned.",
......@@ -189,7 +186,9 @@
},
"/provide_predicted_qos": {
"post": {
"tags": ["QoS"],
"tags": [
"QoS"
],
"summary": "Request the predicted QoS correspondent to potential routes of a vehicular UE.",
"description": "Request the predicted QoS correspondent to potential routes of a vehicular UE.",
"operationId": "predicted_qosPOST",
......@@ -231,7 +230,9 @@
},
"/publish_v2x_message": {
"post": {
"tags": ["V2X_msg"],
"tags": [
"V2X_msg"
],
"summary": "Used to publish a V2X message.",
"description": "Used to publish a V2X message.",
"operationId": "v2x_messagePOST",
......@@ -272,12 +273,13 @@
},
"/subscriptions": {
"get": {
"tags": ["subscription"],
"tags": [
"subscription"
],
"summary": "Request information about the subscriptions for this requestor.",
"description": "Request information about the subscriptions for this requestor.",
"operationId": "subGET",
"parameters": [
{
"parameters": [{
"in": "query",
"name": "subscription_type",
"description": "Query parameter to filter on a specific subscription type. Permitted values: prov_chg_uu_uni: provisioning information change for V2X communication over Uuunicast prov_chg_uu_mbms: provisioning information change for V2X communication over Uu MBMS prov_chg_uu_pc5: provisioning information change for V2X communication over PC5. v2x_msg: V2X interoperability message",
......@@ -285,8 +287,7 @@
"type": "string"
},
"required": false
}
],
}],
"responses": {
"200": {
"description": "A response body containing the list of links to requestor subscriptions is returned.",
......@@ -319,7 +320,9 @@
}
},
"post": {
"tags": ["subscription"],
"tags": [
"subscription"
],
"summary": " create a new subscription to VIS notifications.",
"description": " create a new subscription to VIS notifications.",
"operationId": "subPOST",
......@@ -328,8 +331,7 @@
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"oneOf": [{
"$ref": "#/components/schemas/ProvChgUuUniSubscription"
},
{
......@@ -352,8 +354,7 @@
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"oneOf": [{
"$ref": "#/components/schemas/ProvChgUuUniSubscription"
},
{
......@@ -408,8 +409,7 @@
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"oneOf": [{
"$ref": "#/components/schemas/ProvChgUuUniNotification"
},
{
......@@ -438,8 +438,7 @@
}
},
"/subscriptions/{subscriptionId}": {
"parameters": [
{
"parameters": [{
"in": "path",
"name": "subscriptionId",
"description": "Refers to created subscription, where the VIS API allocates a unique resource name for this subscription",
......@@ -447,10 +446,11 @@
"type": "string"
},
"required": true
}
],
}],
"get": {
"tags": ["subscription"],
"tags": [
"subscription"
],
"summary": "Retrieve information about this subscription.",
"description": "Retrieve information about this subscription.",
"operationId": "individualSubscriptionGET",
......@@ -460,8 +460,7 @@
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"oneOf": [{
"$ref": "#/components/schemas/ProvChgUuUniSubscription"
},
{
......@@ -499,7 +498,9 @@
}
},
"put": {
"tags": ["subscription"],
"tags": [
"subscription"
],
"summary": "Used to update the existing subscription.",
"description": "Used to update the existing subscription.",
"operationId": "individualSubscriptionPUT",
......@@ -508,8 +509,7 @@
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"oneOf": [{
"$ref": "#/components/schemas/ProvChgUuUniSubscription"
},
{
......@@ -532,8 +532,7 @@
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"oneOf": [{
"$ref": "#/components/schemas/ProvChgUuUniSubscription"
},
{
......@@ -577,7 +576,9 @@
}
},
"delete": {
"tags": ["subscription"],
"tags": [
"subscription"
],
"summary": "Used to cancel the existing subscription.",
"description": "Used to cancel the existing subscription.",
"operationId": "individualSubscriptionDELETE",
......@@ -612,7 +613,9 @@
"x-etsi-mec-origin-type": "String"
}
},
"required": ["cellId"],
"required": [
"cellId"
],
"type": "object",
"x-etsi-ref": "6.6.2"
},
......@@ -625,7 +628,9 @@
"x-etsi-mec-origin-type": "Integer"
}
},
"required": ["earfcn"],
"required": [
"earfcn"
],
"type": "object",
"x-etsi-ref": "6.6.3"
},
......@@ -638,7 +643,10 @@
"$ref": "#/components/schemas/Plmn"
}
},
"required": ["plmn", "cellId"],
"required": [
"plmn",
"cellId"
],
"type": "object",
"x-etsi-ref": "6.5.5"
},
......@@ -673,7 +681,9 @@
"$ref": "#/components/schemas/LinkType"
}
},
"required": ["self"],
"required": [
"self"
],
"type": "object",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Structure (inlined)"
......@@ -688,7 +698,9 @@
"x-etsi-mec-origin-type": "Uri"
}
},
"required": ["href"],
"required": [
"href"
],
"type": "object",
"x-etsi-ref": "6.5.13"
},
......@@ -723,7 +735,10 @@
"x-etsi-mec-origin-type": "Float"
}
},
"required": ["latitude", "longitude"],
"required": [
"latitude",
"longitude"
],
"type": "object",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Structure (inlined)"
......@@ -740,35 +755,39 @@
"$ref": "#/components/schemas/SystemInformationBlockType21"
}
},
"required": ["plmn", "ecgi", "siV2xConfig"],
"required": [
"plmn",
"ecgi",
"siV2xConfig"
],
"type": "object",
"x-etsi-ref": "6.5.12"
},
"Pc5ProvisioningInfo": {
"items": {
"properties": {
"proInfoPc5": {
"type": "array",
"minItems": 1,
"items": {
"$ref": "#/components/schemas/Pc5ProvisioningInfo.proInfoPc5"
}
},
"timeStamp": {
"$ref": "#/components/schemas/TimeStamp"
}
},
"type": "object"
},
"required": ["proInfoPc5"],
"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,
"type": "object",
"properties": {
"dstLayer2Id": {
"description": "For sidelink communication, the Destination Layer-2 ID is set to the ProSe Layer-2 Group ID or Prose UE ID, see ETSI TS 136 321 [i.12].\nPLMN operators coordinate to make sure Destination Layer2 ID(s) for different V2X services are configured in a consistent manner.",
"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"
......@@ -787,8 +806,10 @@
"x-etsi-mec-origin-type": "Pc5NeighbourCellInfo"
}
},
"required": ["locationInfo", "dstLayer2Id"],
"type": "array",
"required": [
"locationInfo",
"dstLayer2Id"
],
"x-etsi-mec-cardinality": "1..N",
"x-etsi-mec-origin-type": "Structure (inlined)"
},
......@@ -807,7 +828,10 @@
"x-etsi-mec-origin-type": "String"
}
},
"required": ["mcc", "mnc"],
"required": [
"mcc",
"mnc"
],
"type": "object",
"x-etsi-ref": "6.5.4"
},
......@@ -825,7 +849,9 @@
"$ref": "#/components/schemas/PredictedQos.routes"
},
"minItems": 1,
"required": ["routeInfo"],
"required": [
"routeInfo"
],
"type": "array",
"x-etsi-mec-cardinality": "1..N",
"x-etsi-mec-origin-type": "Structure (inlined)"
......@@ -834,7 +860,10 @@
"$ref": "#/components/schemas/TimeStamp"
}
},
"required": ["locationGranularity", "routes"],
"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"
......@@ -846,7 +875,9 @@
"items": {
"$ref": "#/components/schemas/PredictedQos.routes.routeInfo"
},
"required": ["location"],
"required": [
"location"
],
"minItems": 2,
"type": "array",
"x-etsi-mec-cardinality": "2..N",
......@@ -950,7 +981,10 @@
"$ref": "#/components/schemas/TimeStamp"
}
},
"required": ["notificationType", "locationInfo"],
"required": [
"notificationType",
"locationInfo"
],
"type": "object",
"x-etsi-ref": "6.4.4"
},
......@@ -973,7 +1007,7 @@
"$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.",
"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"
......@@ -988,7 +1022,10 @@
"$ref": "#/components/schemas/WebsockNotifConfig"
}
},
"required": ["subscriptionType", "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"
......@@ -1016,7 +1053,10 @@
"x-etsi-mec-origin-type": "Pc5NeighbourCellInfo"
}
},
"required": ["locationInfo", "dstLayer2Id"],
"required": [
"locationInfo",
"dstLayer2Id"
],
"type": "object",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Structure (inlined)"
......@@ -1049,7 +1089,10 @@
"$ref": "#/components/schemas/V2xServerUsd"
}
},
"required": ["notificationType", "locationInfo"],
"required": [
"notificationType",
"locationInfo"
],
"type": "object",
"x-etsi-ref": "6.4.3"
},
......@@ -1072,7 +1115,7 @@
"$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.",
"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"
......@@ -1087,7 +1130,10 @@
"$ref": "#/components/schemas/WebsockNotifConfig"
}
},
"required": ["subscriptionType", "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"
......@@ -1112,7 +1158,10 @@
"$ref": "#/components/schemas/V2xServerUsd"
}
},
"required": ["locationInfo", "v2xServerUsd"],
"required": [
"locationInfo",
"v2xServerUsd"
],
"type": "object",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Structure (inlined)"
......@@ -1145,7 +1194,10 @@
"$ref": "#/components/schemas/V2xApplicationServer"
}
},
"required": ["notificationType", "locationInfo"],
"required": [
"notificationType",
"locationInfo"
],
"type": "object",
"x-etsi-ref": "6.4.2"
},
......@@ -1168,7 +1220,7 @@
"$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.",
"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"
......@@ -1183,7 +1235,10 @@
"$ref": "#/components/schemas/WebsockNotifConfig"
}
},
"required": ["subscriptionType", "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"
......@@ -1208,7 +1263,10 @@
"$ref": "#/components/schemas/V2xApplicationServer"
}
},
"required": ["locationInfo", "v2xApplicationServer"],
"required": [
"locationInfo",
"v2xApplicationServer"
],
"type": "object",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Structure (inlined)"
......@@ -1219,7 +1277,9 @@
"$ref": "#/components/schemas/SubscriptionLinkList.links"
}
},
"required": ["_links"],
"required": [
"_links"
],
"type": "object",
"x-etsi-ref": "6.3.6"
},
......@@ -1241,33 +1301,37 @@
"$ref": "#/components/schemas/TransmissionBandwidth"
}
},
"required": ["earfcn", "transmissionBandwidth", "subframeAssignment"],
"required": [
"earfcn",
"transmissionBandwidth",
"subframeAssignment"
],
"type": "object",
"x-etsi-ref": "6.5.7"
},
"SubscriptionLinkList.links": {
"description": "List of hyperlinks related to the resource.",
"items": {
"properties": {
"self": {
"$ref": "#/components/schemas/LinkType"
},
"subscriptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubscriptionLinkList.links.subscriptions"
}
}
},
"type": "object"
},
"required": ["self"],
"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"
},
"type": "object",
"minItems": 0,
"properties": {
"href": {
......@@ -1284,8 +1348,10 @@
"x-etsi-mec-origin-type": "String"
}
},
"required": ["href", "subscriptionType"],
"type": "array",
"required": [
"href",
"subscriptionType"
],
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "Structure (inlined)"
},
......@@ -1298,7 +1364,9 @@
"$ref": "#/components/schemas/LinkType"
}
},
"required": ["subscription"],
"required": [
"subscription"
],
"type": "object",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Structure (inlined)"
......@@ -1310,7 +1378,10 @@
"x-etsi-mec-origin-type": "String"
}
},
"required": ["notificationType", "_links"],
"required": [
"notificationType",
"_links"
],
"type": "object",
"x-etsi-ref": "6.4.6"
},
......@@ -1331,7 +1402,10 @@
"x-etsi-mec-origin-type": "Uint32"
}
},
"required": ["seconds", "nanoSeconds"],
"required": [
"seconds",
"nanoSeconds"
],
"type": "object",
"x-etsi-ref": "6.5.2"
},
......@@ -1341,13 +1415,22 @@
"$ref": "#/components/schemas/TransmissionBandwidth.transmissionBandwidth"
}
},
"required": ["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"],
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Enum"
......@@ -1395,27 +1478,27 @@
"x-etsi-ref": "6.5.11"
},
"UuMbmsProvisioningInfo": {
"items": {
"properties": {
"proInfoUuMbms": {
"type": "array",
"minItems": 1,
"items": {
"$ref": "#/components/schemas/UuMbmsProvisioningInfo.proInfoUuMbms"
}
},
"timeStamp": {
"$ref": "#/components/schemas/TimeStamp"
}
},
"type": "object"
},
"required": ["proInfoUuMbms"],
"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,
"type": "object",
"properties": {
"locationInfo": {
"$ref": "#/components/schemas/LocationInfo"
......@@ -1434,8 +1517,10 @@
"$ref": "#/components/schemas/V2xServerUsd"
}
},
"required": ["locationInfo", "v2xServerUsd"],
"type": "array",
"required": [
"locationInfo",
"v2xServerUsd"
],
"x-etsi-mec-cardinality": "1..N",
"x-etsi-mec-origin-type": "Structure (inlined)"
},
......@@ -1460,32 +1545,38 @@
"$ref": "#/components/schemas/TddInfo"
}
},
"required": ["plmn", "ecgi", "pci", "fddInfo", "tddInfo"],
"required": [
"plmn",
"ecgi",
"pci",
"fddInfo",
"tddInfo"
],
"type": "object",
"x-etsi-ref": "6.5.9"
},
"UuUnicastProvisioningInfo": {
"items": {
"properties": {
"proInfoUuUnicast": {
"type": "array",
"minItems": 1,
"items": {
"$ref": "#/components/schemas/UuUnicastProvisioningInfo.proInfoUuUnicast"
}
},
"timeStamp": {
"$ref": "#/components/schemas/TimeStamp"
}
},
"type": "object"
},
"required": ["proInfoUuUnicast"],
"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,
"type": "object",
"properties": {
"locationInfo": {
"$ref": "#/components/schemas/LocationInfo"
......@@ -1504,8 +1595,10 @@
"$ref": "#/components/schemas/V2xApplicationServer"
}
},
"required": ["locationInfo", "v2xApplicationServer"],
"type": "array",
"required": [
"locationInfo",
"v2xApplicationServer"
],
"x-etsi-mec-cardinality": "1..N",
"x-etsi-mec-origin-type": "Structure (inlined)"
},
......@@ -1524,7 +1617,10 @@
"x-etsi-mec-origin-type": "String"
}
},
"required": ["ipAddress", "udpPort"],
"required": [
"ipAddress",
"udpPort"
],
"type": "object",
"x-etsi-ref": "6.5.8"
},
......@@ -1556,7 +1652,9 @@
},
"stdOrganization": {
"description": "Standardization organization which defines the published V2X message type: \nETSI: European Telecommunications Standards Institute.\nSee note 1.",
"enum": ["ETSI"],
"enum": [
"ETSI"
],
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Enum"
......@@ -1585,7 +1683,9 @@
"$ref": "#/components/schemas/LinkType"
}
},
"required": ["subscription"],
"required": [
"subscription"
],
"type": "object",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Structure (inlined)"
......@@ -1609,7 +1709,9 @@
},
"stdOrganization": {
"description": "Standardization organization which defines the published V2X message type:\nETSI: European Telecommunications Standards Institute. \nSee note 1.",
"enum": ["ETSI"],
"enum": [
"ETSI"
],
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Enum"
......@@ -1628,19 +1730,19 @@
"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"
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13
],
"type": "integer",
"x-etsi-mec-cardinality": "1",
......@@ -1665,7 +1767,7 @@
"$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.",
"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"
......@@ -1680,7 +1782,10 @@
"$ref": "#/components/schemas/WebsockNotifConfig"
}
},
"required": ["subscriptionType", "filterCriteria"],
"required": [
"subscriptionType",
"filterCriteria"
],
"type": "object",
"x-etsi-notes": "NOTE 1:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to VIS to choose an alternative and return only that alternative in the response, as described in ETSI GS MEC 009 [i.1], clause 6.12a.\nNOTE 2:\tOther standardization organizations could be added as needed.\nNOTE 3:\tThe V2X message types of ETSI shall be used as specified in ETSI TS 102 894-2 [6], clause A.114.",
"x-etsi-ref": "6.3.5"
......@@ -1700,13 +1805,17 @@
},
"stdOrganization": {
"description": "Standardization organization which defines the subscribed V2X message type: \nETSI: European Telecommunications Standards Institute. \nSee note 2.",
"enum": ["ETSI"],
"enum": [
"ETSI"
],
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Enum"
}
},
"required": ["stdOrganization"],
"required": [
"stdOrganization"
],
"type": "object",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Structure (inlined)"
......@@ -1730,7 +1839,11 @@
"$ref": "#/components/schemas/V2xServerUsd.tmgi"
}
},
"required": ["tmgi", "serviceAreaIdentifier", "sdpInfo"],
"required": [
"tmgi",
"serviceAreaIdentifier",
"sdpInfo"
],
"type": "object",
"x-etsi-ref": "6.5.10"
},
......@@ -1750,7 +1863,10 @@
"x-etsi-mec-origin-type": "String"
}
},
"required": ["ipMulticastAddress", "portNumber"],
"required": [
"ipMulticastAddress",
"portNumber"
],
"type": "object",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Structure (inlined)"
......@@ -1777,7 +1893,11 @@
"x-etsi-mec-origin-type": "String"
}
},
"required": ["mbmsServiceId", "mcc", "mnc"],
"required": [
"mbmsServiceId",
"mcc",
"mnc"
],
"type": "object",
"x-etsi-mec-cardinality": "",
"x-etsi-mec-origin-type": "Structure (inlined)"
......
MEC030_V2XInformationService.yaml
View file @ 6b02e98c
openapi: 3.0.0
openapi: 3.1.0
info:
title: 'ETSI GS MEC 030 V2X Information Service API'
version: 2.1.9
......@@ -547,25 +547,24 @@ components:
type: object
x-etsi-ref: 6.5.12
Pc5ProvisioningInfo:
items:
properties:
proInfoPc5:
type: array
minItems: 1
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'
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 Layer2 ID(s) for different V2X services are configured in a consistent manner."
......@@ -588,7 +587,6 @@ components:
required:
- locationInfo
- dstLayer2Id
type: array
x-etsi-mec-cardinality: 1..N
x-etsi-mec-origin-type: Structure (inlined)
Plmn:
......@@ -1049,7 +1047,6 @@ components:
x-etsi-ref: 6.5.7
SubscriptionLinkList.links:
description: List of hyperlinks related to the resource.
items:
properties:
self:
# description': URI of this resource.
......@@ -1057,8 +1054,9 @@ components:
# x-etsi-mec-origin-type': LinkType
$ref: '#/components/schemas/LinkType'
subscriptions:
type: array
items:
$ref: '#/components/schemas/SubscriptionLinkList.links.subscriptions'
type: object
required:
- self
type: object
......@@ -1066,7 +1064,6 @@ components:
x-etsi-mec-origin-type: Structure (inlined)
SubscriptionLinkList.links.subscriptions:
description: The service consumer's subscriptions.
items:
type: object
minItems: 0
properties:
......@@ -1084,7 +1081,6 @@ components:
required:
- href
- subscriptionType
type: array
x-etsi-mec-cardinality: 0..N
x-etsi-mec-origin-type: Structure (inlined)
TestNotification:
......@@ -1209,25 +1205,24 @@ components:
type: object
x-etsi-ref: 6.5.11
UuMbmsProvisioningInfo:
items:
properties:
proInfoUuMbms:
type: array
minItems: 1
items:
$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.
......@@ -1250,7 +1245,6 @@ components:
required:
- locationInfo
- v2xServerUsd
type: array
x-etsi-mec-cardinality: 1..N
x-etsi-mec-origin-type: Structure (inlined)
UuUniNeighbourCellInfo:
......@@ -1289,25 +1283,24 @@ components:
type: object
x-etsi-ref: 6.5.9
UuUnicastProvisioningInfo:
items:
properties:
proInfoUuUnicast:
type: array
minItems: 1
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'
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.
......@@ -1330,7 +1323,6 @@ components:
required:
- locationInfo
- v2xApplicationServer
type: array
x-etsi-mec-cardinality: 1..N
x-etsi-mec-origin-type: Structure (inlined)
V2xApplicationServer:
......