Skip to content
GitLab
Commit 6b02e98c authored by Walter Featherstone's avatar Walter Featherstone
Browse files

Merge branch 'stf606-final' into 'master' 

Fix on missing datamodels

See merge request !8
parents 482f9375 54bd42b7
Pipeline #11136 failed with stage
in 0 seconds
Hide whitespace changes
Inline Side-by-side
MEC030_V2XInformationService.json
View file @ 6b02e98c
{
"openapi": "3.1.0",
"info": {
"title": "ETSI GS MEC 030 V2X Information Service API",
"version": "2.1.9",
"description": "ETSI GS MEC 030 V2X Information Service API described using OpenAPI.",
"contact": {
"name": "ETSI Forge",
"email": "cti_support@etsi.org",
"url": "https://forge.etsi.org/rep/mec/gs030-vis-api"
},
"license": {
"name": "BSD-3-Clause",
"url": "https://forge.etsi.org/legal-matters"
}
},
"externalDocs": {
"description": "ETSI GS MEC 030 V2X Information Service API, v2.1.9",
"url": ""
},
"servers": [
{
"url": "https://localhost/vis/v2"
}
],
"tags": [
{
"name": "queries",
"description": "Queries"
},
{
"name": "subscription",
"description": "Subscription"
},
{
"name": "QoS"
},
{
"name": "V2X_msg"
}
],
"paths": {
"/queries/uu_unicast_provisioning_info": {
"get": {
"tags": ["queries"],
"summary": "Used to query provisioning information for V2X communication over Uu unicast.",
"description": "Used to query provisioning information for V2X communication over Uu unicast.",
"operationId": "prov_info_uu_unicastGET",
"parameters": [
{
"in": "query",
"name": "location_info",
"schema": {
"type": "string"
},
"required": true,
"description": "Comma separated list of locations to identify a cell of a base station or a particular geographical area"
}
],
"responses": {
"200": {
"description": "A response body containing the Uu unicast provisioning information. ",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UuUnicastProvisioningInfo"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"429": {
"$ref": "#/components/responses/429"
}
}
}
},
"/queries/uu_mbms_provisioning_info": {
"get": {
"tags": ["queries"],
"summary": "retrieve information required for V2X communication over Uu MBMS.",
"description": "retrieve information required for V2X communication over Uu MBMS.",
"operationId": "prov_info_uu_mbmsGET",
"parameters": [
{
"in": "query",
"name": "location_info",
"schema": {
"type": "string"
},
"required": true,
"description": "omma separated list of locations to identify a cell of a base station or a particular geographical area"
}
],
"responses": {
"200": {
"description": "A response body containing the Uu unicast provisioning information. ",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UuMbmsProvisioningInfo"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"429": {
"$ref": "#/components/responses/429"
}
}
}
},
"/queries/pc5_provisioning_info": {
"get": {
"tags": ["queries"],
"summary": "Query provisioning information for V2X communication over PC5.",
"description": "Query provisioning information for V2X communication over PC5.",
"operationId": "prov_infoGET",
"parameters": [
{
"in": "query",
"name": "location_info",
"schema": {
"type": "string"
},
"required": true,
"description": "Comma separated list of locations to identify a cell of a base station or a particular geographical area"
}
],
"responses": {
"200": {
"description": "A response body containing the PC5 provisioning information is returned.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Pc5ProvisioningInfo"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"429": {
"$ref": "#/components/responses/429"
}
}
}
},
"/provide_predicted_qos": {
"post": {
"tags": ["QoS"],
"summary": "Request the predicted QoS correspondent to potential routes of a vehicular UE.",
"description": "Request the predicted QoS correspondent to potential routes of a vehicular UE.",
"operationId": "predicted_qosPOST",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PredictedQos"
}
}
}
},
"responses": {
"200": {
"description": "The response body shall contain the predicted QoS corresponding to potential routes of a vehicular UE",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PredictedQos"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
}
}
}
},
"/publish_v2x_message": {
"post": {
"tags": ["V2X_msg"],
"summary": "Used to publish a V2X message.",
"description": "Used to publish a V2X message.",
"operationId": "v2x_messagePOST",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/V2xMsgPublication"
}
}
}
},
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"429": {
"$ref": "#/components/responses/429"
}
}
}
},
"/subscriptions": {
"get": {
"tags": ["subscription"],
"summary": "Request information about the subscriptions for this requestor.",
"description": "Request information about the subscriptions for this requestor.",
"operationId": "subGET",
"parameters": [
{
"in": "query",
"name": "subscription_type",
"description": "Query parameter to filter on a specific subscription type. Permitted values: prov_chg_uu_uni: provisioning information change for V2X communication over Uuunicast prov_chg_uu_mbms: provisioning information change for V2X communication over Uu MBMS prov_chg_uu_pc5: provisioning information change for V2X communication over PC5. v2x_msg: V2X interoperability message",
"schema": {
"type": "string"
},
"required": false
}
],
"responses": {
"200": {
"description": "A response body containing the list of links to requestor subscriptions is returned.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionLinkList"
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"429": {
"$ref": "#/components/responses/429"
}
}
},
"post": {
"tags": ["subscription"],
"summary": " create a new subscription to VIS notifications.",
"description": " create a new subscription to VIS notifications.",
"operationId": "subPOST",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ProvChgUuUniSubscription"
},
{
"$ref": "#/components/schemas/ProvChgUuMbmsSubscription"
},
{
"$ref": "#/components/schemas/ProvChgPc5Subscription"
},
{
"$ref": "#/components/schemas/V2xMsgSubscription"
}
]
}
}
}
},
"responses": {
"201": {
"description": "In the returned NotificationSubscription structure, the created subscription is described using the appropriate data type.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ProvChgUuUniSubscription"
},
{
"$ref": "#/components/schemas/ProvChgUuMbmsSubscription"
},
{
"$ref": "#/components/schemas/ProvChgPc5Subscription"
},
{
"$ref": "#/components/schemas/V2xMsgSubscription"
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"415": {
"$ref": "#/components/responses/415"
},
"422": {
"$ref": "#/components/responses/422"
},
"429": {
"$ref": "#/components/responses/429"
}
},
"callbacks": {
"notification": {
"{$request.body#/callbackReference}": {
"post": {
"summary": "Callback POST used to send a notification",
"description": "A notification from VIS.",
"operationId": "notificationPOST",
"requestBody": {
"description": "Subscription notification",
"required": true,
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ProvChgUuUniNotification"
},
{
"$ref": "#/components/schemas/ProvChgUuMbmsNotification"
},
{
"$ref": "#/components/schemas/ProvChgPc5Notification"
},
{
"$ref": "#/components/schemas/V2xMsgNotification"
}
]
}
}
}
},
"responses": {
"204": {
"$ref": "#/components/responses/204"
}
}
}
}
}
}
}
},
"/subscriptions/{subscriptionId}": {
"parameters": [
{
"in": "path",
"name": "subscriptionId",
"description": "Refers to created subscription, where the VIS API allocates a unique resource name for this subscription",
"schema": {
"type": "string"
},
"required": true
}
],
"get": {
"tags": ["subscription"],
"summary": "Retrieve information about this subscription.",
"description": "Retrieve information about this subscription.",
"operationId": "individualSubscriptionGET",
"responses": {
"200": {
"description": "A response body containing the data type describing the specific RNI event subscription is returned",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ProvChgUuUniSubscription"
},
{
"$ref": "#/components/schemas/ProvChgUuMbmsSubscription"
},
{
"$ref": "#/components/schemas/ProvChgPc5Subscription"
},
{
"$ref": "#/components/schemas/V2xMsgSubscription"
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"429": {
"$ref": "#/components/responses/429"
}
}
},
"put": {
"tags": ["subscription"],
"summary": "Used to update the existing subscription.",
"description": "Used to update the existing subscription.",
"operationId": "individualSubscriptionPUT",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ProvChgUuUniSubscription"
},
{
"$ref": "#/components/schemas/ProvChgUuMbmsSubscription"
},
{
"$ref": "#/components/schemas/ProvChgPc5Subscription"
},
{
"$ref": "#/components/schemas/V2xMsgSubscription"
}
]
}
}
}
},
"responses": {
"200": {
"description": "A response body containing data type describing the updated subscription is returned",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ProvChgUuUniSubscription"
},
{
"$ref": "#/components/schemas/ProvChgUuMbmsSubscription"
},
{
"$ref": "#/components/schemas/ProvChgPc5Subscription"
},
{
"$ref": "#/components/schemas/V2xMsgSubscription"
}
]
}
}
}
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"406": {
"$ref": "#/components/responses/406"
},
"412": {
"$ref": "#/components/responses/412"
},
"422": {
"$ref": "#/components/responses/422"
},
"429": {
"$ref": "#/components/responses/429"
}
}
},
"delete": {
"tags": ["subscription"],
"summary": "Used to cancel the existing subscription.",
"description": "Used to cancel the existing subscription.",
"operationId": "individualSubscriptionDELETE",
"responses": {
"204": {
"$ref": "#/components/responses/204"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"429": {
"$ref": "#/components/responses/429"
}
}
}
}
},
"components": {
"schemas": {
"CellId": {
"properties": {
"cellId": {
"description": "E-UTRAN Cell Identity as a bit string (size (28)).",
"type": "string",
"x-etsi-mec