diff --git a/.jenkins.sh b/.jenkins.sh new file mode 100755 index 0000000000000000000000000000000000000000..74d0370875e23476bf3a058ebcb825f7494b3de7 --- /dev/null +++ b/.jenkins.sh @@ -0,0 +1,18 @@ +#!/bin/bash + +specfiles=$(ls | egrep "^[^.]*.(json|yaml)") + +fres=0 +for i in $specfiles ; do + echo "-- Validating and linting OpenAPI file $i..." + swagger-cli validate $i + res=$? + speccy lint "$i" + res2=$? + fres=$(($fres||$res||$res2)) + echo "--- Validator returned $res, linter returned $res2." +done + +echo "-- Final validator returns $fres." +exit $fres + diff --git a/MEC021_AppMobilityService.json b/MEC021_AppMobilityService.json new file mode 100644 index 0000000000000000000000000000000000000000..daea06d3d4c4979eb6c7614621a31b58d9480828 --- /dev/null +++ b/MEC021_AppMobilityService.json @@ -0,0 +1,1302 @@ +{ + "info": { + "title": "ETSI GS MEC 021 Application Mobility Service API", + "version": "2.1.1", + "description": "ETSI GS MEC 021 Application Mobility Service API described using OpenAPI.", + "license": { + "name": "BSD-3-Clause", + "url": "https://forge.etsi.org/legal-matters" + }, + "contact": { + "name": "ETSI Forge", + "email": "cti_support@etsi.org", + "url": "https://forge.etsi.org/rep/mec/gs021-amsi-api" + } + }, + "externalDocs": { + "description": "ETSI GS MEC 021 Application Mobility Service API, v2.1.1", + "url": "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/021/02.01.01_60/gs_mec021v020101p.pdf" + }, + "servers": [ + { + "url": "https://localhost/amsi/v1" + } + ], + "openapi": "3.0.0", + "tags": [ + { + "name": "adj-app-inst", + "description": "Adjacent App instances" + }, + { + "name": "app-mob-ser", + "description": "Application Mobility Services" + }, + { + "name": "app-mob-ser-der", + "description": "Application Mobility Services Deregister task" + }, + { + "name": "subscriptions", + "description": "Subscription for Application Mobility Service" + } + ], + "paths": { + "/app_mobility_services": { + "get": { + "tags": [ + "app-mob-ser" + ], + "summary": " Retrieve information about the registered application mobility service.", + "description": " Retrieve information about the registered application mobility service.", + "operationId": "app_mobility_serviceGET", + "parameters": [ + { + "in": "query", + "name": "filter", + "schema": { + "type": "string" + }, + "required": false, + "description": "Attribute-based filtering parameters according to ETSI GS MEC 011" + }, + { + "in": "query", + "name": "all_fields", + "schema": { + "type": "string" + }, + "required": false, + "description": "Include all complex attributes in the response." + }, + { + "in": "query", + "name": "fields", + "schema": { + "type": "string" + }, + "required": false, + "description": "Complex attributes to be included into the response. See clause 6.18 in ETSI GS MEC 011" + }, + { + "in": "query", + "name": "exclude_fields", + "schema": { + "type": "string" + }, + "required": false, + "description": "Complex attributes to be excluded from the response.See clause 6.18 in ETSI GS MEC 011" + }, + { + "in": "query", + "name": "exclude_default", + "schema": { + "type": "string" + }, + "required": false, + "description": "Indicates to exclude the following complex attributes from the response See clause 6.18 in ETSI GS MEC 011 for details." + } + ], + "responses": { + "200": { + "description": "Contains in an array the representations of zero or more application mobility services.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RegistrationInfo" + } + } + } + } + }, + "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": [ + "app-mob-ser" + ], + "summary": "Create a new application mobility service for the service requester.", + "description": "Create a new application mobility service for the service requester.", + "operationId": "app_mobility_servicePOST", + "requestBody": { + "description": "Application mobility service to be created", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RegistrationInfo" + } + } + } + }, + "responses": { + "201": { + "description": "Successful response for application mobility service creation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RegistrationInfo" + } + } + } + }, + "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" + } + } + } + }, + "/app_mobility_services/{appMobilityServiceId}": { + "parameters": [ + { + "in": "path", + "name": "appMobilityServiceId", + "schema": { + "type": "string" + }, + "required": true, + "description": "It uniquely identifies the created individual application mobility service" + } + ], + "get": { + "tags": [ + "app-mob-ser" + ], + "summary": "Retrieve information about this individual application mobility service", + "description": "Retrieve information about this individual application mobility service", + "operationId": "app_mobility_service_by_idGET", + "responses": { + "200": { + "description": "Contains a representation of the application mobility service.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RegistrationInfo" + } + } + } + }, + "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": [ + "app-mob-ser" + ], + "summary": " update the existing individual application mobility service", + "description": " update the existing individual application mobility service", + "operationId": "app_mobility_service_by_idPUT", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RegistrationInfo" + } + } + } + }, + "responses": { + "200": { + "description": "Contains a data type describing the updated application mobility service.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RegistrationInfo" + } + } + } + }, + "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": [ + "app-mob-ser" + ], + "summary": " deregister the individual application mobility service", + "description": " deregister the individual application mobility service", + "operationId": "app_mobility_service_by_idDELETE", + "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" + } + } + } + }, + "/app_mobility_services/{appMobilityServiceId}/deregister_task": { + "parameters": [ + { + "in": "path", + "name": "appMobilityServiceId", + "schema": { + "type": "string" + }, + "description": "It uniquely identifies the created individual application mobility service", + "required": true + } + ], + "post": { + "tags": [ + "app-mob-ser-der" + ], + "summary": " deregister the individual application mobility service", + "description": " deregister the individual application mobility service", + "operationId": "app_mobility_service_derPOST", + "responses": { + "204": { + "$ref": "#/components/responses/204" + }, + "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": [ + "subscriptions" + ], + "summary": "Retrieve information about the subscriptions for this requestor.", + "description": "Retrieve information about the subscriptions for this requestor.", + "operationId": "subGET", + "parameters": [ + { + "in": "query", + "name": "subscriptionType", + "description": "Query parameter to filter on a specific subscription type. Permitted values: mobility_proc or adj_app_info", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "Contains the list of links to requestor subscriptions.", + "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": [ + "subscriptions" + ], + "summary": "Create a new subscription to Application Mobility Service notifications.", + "description": "Create a new subscription to Application Mobility Service notifications.", + "operationId": "subPOST", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/MobilityProcedureSubscription" + }, + { + "$ref": "#/components/schemas/AdjacentAppInfoSubscription" + } + ] + } + } + } + }, + "responses": { + "201": { + "description": "Created subscription is described using the appropriate data type", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/MobilityProcedureSubscription" + }, + { + "$ref": "#/components/schemas/AdjacentAppInfoSubscription" + } + ] + } + } + } + }, + "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" + } + } + } + }, + "/subscriptions/{subscriptionId}": { + "parameters": [ + { + "in": "path", + "name": "subscriptionId", + "description": "Refers to created subscription, where the AMS API allocates a unique resource name for this subscription", + "schema": { + "type": "string" + }, + "required": true + } + ], + "get": { + "tags": [ + "subscriptions" + ], + "summary": "Retrieve information about this subscription.", + "description": "Retrieve information about this subscription.", + "operationId": "sub_byIdGET", + "responses": { + "200": { + "description": "A response body containing data type describing the specific RNI event subscription", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/MobilityProcedureSubscription" + }, + { + "$ref": "#/components/schemas/AdjacentAppInfoSubscription" + } + ] + } + } + } + }, + "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": [ + "subscriptions" + ], + "summary": "update the existing individual subscription.", + "description": "update the existing individual subscription.", + "operationId": "sub_byIdPUT", + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/MobilityProcedureSubscription" + }, + { + "$ref": "#/components/schemas/AdjacentAppInfoSubscription" + } + ] + } + } + } + }, + "responses": { + "200": { + "description": " a response body containing data type describing the updated subscription", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/MobilityProcedureSubscription" + }, + { + "$ref": "#/components/schemas/AdjacentAppInfoSubscription" + } + ] + } + } + } + }, + "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": [ + "subscriptions" + ], + "summary": "cancel the existing individual subscription", + "description": "cancel the existing individual subscription", + "operationId": "sub_byIdDELETE", + "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" + } + } + } + }, + "/queries/adjacent_app_instances": { + "get": { + "tags": [ + "adj-app-inst" + ], + "summary": "Retrieve information about this subscription.", + "description": "Retrieve information about this subscription.", + "operationId": "adj_app_instGET", + "parameters": [ + { + "in": "query", + "name": "filter", + "schema": { + "type": "string" + }, + "required": false, + "description": "Attribute-based filtering parameters according to ETSI GS MEC 011" + }, + { + "in": "query", + "name": "all_fields", + "schema": { + "type": "string" + }, + "required": false, + "description": "Include all complex attributes in the response." + }, + { + "in": "query", + "name": "fields", + "schema": { + "type": "string" + }, + "required": false, + "description": "Complex attributes to be included into the response. See clause 6.18 in ETSI GS MEC 011" + }, + { + "in": "query", + "name": "exclude_fields", + "schema": { + "type": "string" + }, + "required": false, + "description": "Complex attributes to be excluded from the response.See clause 6.18 in ETSI GS MEC 011" + }, + { + "in": "query", + "name": "exclude_default", + "schema": { + "type": "string" + }, + "required": false, + "description": "Indicates to exclude the following complex attributes from the response See clause 6.18 in ETSI GS MEC 011 for details." + } + ], + "responses": { + "200": { + "description": "A response body containing zero or more adjacent application instances ", + "content": { + "application/json": { + "schema": { + "type": "array", + "minItems": 0, + "items": { + "$ref": "#/components/schemas/AdjacentAppInstanceInfo" + } + } + } + } + }, + "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" + } + } + } + } + }, + "components": { + "schemas": { + "AdjacentAppInfoSubscription.links": { + "description": "Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.", + "x-etsi-mec-cardinality": "0..1", + "required": [ + "self" + ], + "properties": { + "self": { + "$ref": "#/components/schemas/LinkType" + } + } + }, + "AdjacentAppInfoSubscription.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": "0..1", + "properties": { + "appInstanceId": { + "type": "string" + } + } + }, + "AdjacentAppInfoSubscription": { + "properties": { + "_links": { + "$ref": "#/components/schemas/AdjacentAppInfoSubscription.links" + }, + "callbackReference": { + "description": "URI selected by the service consumer to receive notifications on the subscribed Application Mobility Service. 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/AdjacentAppInfoSubscription.filterCriteria" + }, + "subscriptionType": { + "description": "Shall be set to \"AdjacentAppInfoSubscription\".", + "type": "string", + "enum": [ + "AdjacentAppInfoSubscription" + ], + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + } + }, + "required": [ + "subscriptionType", + "callbackReference", + "filterCriteria" + ], + "type": "object", + "x-etsi-ref": "7.3.3" + }, + "AdjacentAppInstanceInfo": { + "properties": { + "appDId": { + "description": "Identifier of the application descriptor.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "appInstanceCommLink": { + "description": "It specifies the communication interface of application instance.", + "type": "array", + "items": { + "$ref": "#/components/schemas/CommunicationInterface" + }, + "minItems": 1 + }, + "appInstanceId": { + "description": "Identifier of the application instance.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + }, + "mecHostInformation": { + "$ref": "#/components/schemas/MECHostInformation" + } + }, + "required": [ + "appInstanceId", + "appDId", + "appInstanceCommLink" + ], + "type": "object", + "x-etsi-ref": "7.2.3" + }, + "AppMobilityServiceLevel": { + "description": "This attribute provides an option for the application instance (server) to communicate with the application client before relocating this application instance to another MEC host.", + "enum": [ + "APP_MOBILITY_NOT_ALLOWED", + "APP_MOBILITY_WITH_CONFIRMATION", + "APP_MOBILITY_WITHOUT_CONFIRMATION" + ], + "type": "string", + "x-etsi-notes": "APP_MOBILITY_NOT_ALLOWED: the current serving application instance continues to deliver the service to the device. The AMS will inform the MEP to perform the traffic steering to the device when the UE moves cross MEC hosts. − APP_MOBILITY_WITH_CONFIRMATION: the serving application instance is allowed to change with the confirmation by the application once the device mobility happens. The AMS then will inform the MEP to update the traffic routing to the target application instance and clean up the previous resource allocated to the application instance serving to the device after the serving application instance has been changed. − APP_MOBILITY_WITHOUT_CONFIRMATION: the serving application instance is allowed to change without confirmation from the application instance when the device mobility happens. The AMS will notify to the MEP to update the traffic routing to the target application instance and clean up the previous resource allocated to the application instance serving to the device after the serving application instance has been changed." + }, + "CommunicationInterface.IpAddresses": { + "required": [ + "host", + "port" + ], + "properties": { + "host": { + "type": "string" + }, + "port": { + "type": "integer" + } + } + }, + "CommunicationInterface": { + "properties": { + "ipAddresses": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CommunicationInterface.IpAddresses" + } + } + } + }, + "MobilityProcedureSubscription.links": { + "properties": { + "self": { + "$ref": "#/components/schemas/LinkType" + } + }, + "required": [ + "self" + ] + }, + "MobilityProcedureSubscription.filterCriteria": { + "x-etsi-mec-cardinality": "1", + "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": { + "appInstanceId": { + "description": "Identifier of the application instance that registers the application mobility service.", + "type": "string", + "x-etsi-mec-cardinality": "0..1" + }, + "associateId": { + "description": "0 to N identifiers to associate the information for specific UE(s) and flow(s).", + "items": { + "$ref": "#/components/schemas/AssociateId" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N" + }, + "mobilityStatus": { + "description": "In case mobilityStatus is not included in the subscription request, the default value 1 = INTER_HOST_MOBILITY_TRIGGERED shall be used and included in the response.", + "items": { + "$ref": "#/components/schemas/MobilityStatus" + }, + "minItems": 0, + "type": "array", + "x-etsi-mec-cardinality": "0..N" + } + } + }, + "MobilityProcedureSubscription": { + "type": "object", + "x-etsi-ref": "7.3.2", + "properties": { + "_links": { + "$ref": "#/components/schemas/MobilityProcedureSubscription.links" + }, + "callbackReference": { + "description": "URI selected by the service consumer to receive notifications on the subscribed Application Mobility Service. 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/MobilityProcedureSubscription.filterCriteria" + }, + "subscriptionType": { + "description": "Shall be set to \"MobilityProcedureSubscription\".", + "type": "string", + "enum": [ + "MobilityProcedureSubscription" + ], + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + } + }, + "required": [ + "subscriptionType", + "callbackReference", + "filterCriteria" + ] + }, + "MobilityStatus": { + "description": "Indicate the status of the UE mobility", + "enum": [ + "INTERHOST_MOVEOUT_TRIGGERED", + "INTERHOST_MOVEOUT_COMPLETED", + "INTERHOST_MOVEOUT_FAILED" + ], + "type": "string" + }, + "RegistrationInfo.deviceInformation": { + "required": [ + "serviceConsumerId", + "associateId" + ], + "properties": { + "associateId": { + "$ref": "#/components/schemas/AssociateId" + }, + "appMobilityServiceLevel": { + "$ref": "#/components/schemas/AppMobilityServiceLevel" + }, + "contextTransferState": { + "$ref": "#/components/schemas/contextTransferState" + } + } + }, + "RegistrationInfo.serviceConsumerId": { + "description": "The identifier of service consumer requesting the application mobility service, i.e. either the application instance ID or the MEC platform ID.", + "properties": { + "appInstanceId": { + "description": "If present, it represents the identifier of the application instance registering the application mobility service.", + "type": "string", + "x-etsi-mec-cardinality": "0..1" + }, + "mepId": { + "description": "If present, it represents the identifier of the MEC platform registering the application mobility service.", + "type": "string", + "x-etsi-mec-cardinality": "0..1" + } + } + }, + "RegistrationInfo": { + "type": "object", + "properties": { + "appMobilityServiceId": { + "description": "The identifier of registered application mobility service. Shall be absent in POST requests, and present otherwise.", + "type": "string", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "String" + }, + "deviceInformation": { + "description": "If present, it specifies the device served by the application instance which is registering the application mobility service.", + "type": "array", + "minItems": 0, + "items": { + "$ref": "#/components/schemas/RegistrationInfo.deviceInformation" + } + }, + "expiryTime": { + "description": "If present, it indicates the time of application mobility service expiration from the time of registration accepted.The value \"0\" means infinite time, i.e. no expiration.The unit of expiry time is one second.", + "format": "Uint32", + "type": "integer", + "x-etsi-mec-cardinality": "0..1", + "x-etsi-mec-origin-type": "Uint32" + }, + "serviceConsumerId": { + "$ref": "#/components/schemas/RegistrationInfo.serviceConsumerId" + } + }, + "required": [ + "serviceConsumerId" + ], + "x-etsi-notes": "NOTE:\tThe data type of AssociateId is defined in ETSI GS MEC 012 [6].", + "x-etsi-ref": "7.2.2" + }, + "SubscriptionLinkList.links": { + "description": "List of hyperlinks related to the resource.", + "properties": { + "self": { + "$ref": "#/components/schemas/LinkType" + } + }, + "required": [ + "self" + ] + }, + "SubscriptionLinkList.subscription": { + "properties": { + "href": { + "description": "The URI referring to the subscription.", + "format": "uri", + "type": "string", + "x-etsi-mec-cardinality": "1" + }, + "subscriptionType": { + "$ref": "#/components/schemas/subscriptionType" + } + }, + "required": [ + "href", + "subscriptionType" + ] + }, + "SubscriptionLinkList": { + "properties": { + "_links": { + "$ref": "#/components/schemas/SubscriptionLinkList.links" + }, + "subscription": { + "description": "A link to a subscription.", + "type": "array", + "minItems": 0, + "items": { + "$ref": "#/components/schemas/SubscriptionLinkList.subscription" + }, + "x-etsi-mec-cardinality": "0..N" + } + }, + "required": [ + "_links" + ], + "x-etsi-ref": "7.3.4" + }, + "contextTransferState": { + "description": "If present, it represents the state of transferring the user context to another application instance.", + "enum": [ + "NOT_TRANSFERRED", + "USER_CONTEXT_TRANSFER_COMPLETED" + ], + "type": "string" + }, + "subscriptionType": { + "description": "Numeric value (0 - 255) corresponding to specified type of subscription as following: 0 = RESERVED. 1 = MOBILITY_PROCEDURE. 2 = ADJACENT_APPINFO. ", + "enum": [ + 0, + 1, + 2 + ], + "type": "integer" + }, + "Seconds": { + "description": "'The seconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.'", + "type": "integer", + "format": "uint32" + }, + "NanoSeconds": { + "description": "'The nanoseconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.'", + "type": "integer", + "format": "uint32" + }, + "HostName": { + "description": "Human-readable name of MEC host.", + "type": "string" + }, + "KeyValuePairs": { + "description": "'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259'", + "type": "object", + "additionalProperties": true + }, + "AssociateId": { + "properties": { + "type": { + "description": "Numeric value (0-255) corresponding to specified type of identifier", + "enum": [ + "UE_IPv4_ADDRESS", + "UE_IPV6_ADDRESS", + "NATED_IP_ADDRESS", + "GTP_TEID" + ], + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "Enum" + }, + "value": { + "description": "Value for the identifier.", + "type": "string", + "x-etsi-mec-cardinality": "1", + "x-etsi-mec-origin-type": "String" + } + }, + "required": [ + "type", + "value" + ], + "type": "object", + "x-etsi-ref": "6.5.4" + }, + "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" + }, + "TimeStamp": { + "description": "'This data type represents the time stamp as Unix-time since January 1, 1970, 00:00:00 UTC'", + "type": "object", + "required": [ + "seconds", + "nanoSeconds" + ], + "properties": { + "seconds": { + "$ref": "#/components/schemas/Seconds" + }, + "nanoSeconds": { + "$ref": "#/components/schemas/NanoSeconds" + } + } + }, + "MECHostInformation": { + "description": "'The data type represents the parameters of MEC host information.'", + "type": "object", + "required": [ + "hostId" + ], + "properties": { + "hostName": { + "$ref": "#/components/schemas/HostName" + }, + "hostId": { + "$ref": "#/components/schemas/KeyValuePairs" + } + } + }, + "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" + } + }, + "responses": { + "204": { + "description": "No Content" + }, + "206": { + "description": "Partial content" + }, + "400": { + "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "401": { + "description": "Unauthorized : used when the client did not submit credentials.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "403": { + "description": "Forbidden : operation is not allowed given the current status of the resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "406": { + "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "412": { + "description": "Precondition failed : used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "415": { + "description": "Unsupported Media Type : used to indicate that the server or the client does not support the content type of the entity body.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "422": { + "description": "Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "429": { + "description": "Too Many Requests : used when a rate limiter has triggered.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + } + } + } +} \ No newline at end of file diff --git a/MEC021_AppMobilityService.yaml b/MEC021_AppMobilityService.yaml new file mode 100644 index 0000000000000000000000000000000000000000..9d2a5a39896e59d53e0f0d63a49f3b14661b17f6 --- /dev/null +++ b/MEC021_AppMobilityService.yaml @@ -0,0 +1,953 @@ +info: + title: "ETSI GS MEC 021 Application Mobility Service API" + version: 2.1.1 + description: "ETSI GS MEC 021 Application Mobility Service API described using OpenAPI." + license: + name: BSD-3-Clause + url: 'https://forge.etsi.org/legal-matters' + contact: + name: ETSI Forge + email: cti_support@etsi.org + url: https://forge.etsi.org/rep/mec/gs021-amsi-api +externalDocs: + description: "ETSI GS MEC 021 Application Mobility Service API, v2.1.1" + url: 'https://www.etsi.org/deliver/etsi_gs/MEC/001_099/021/02.01.01_60/gs_mec021v020101p.pdf' +servers: + - url: 'https://localhost/amsi/v1' +openapi: 3.0.0 +tags: + - name: adj-app-inst + description: Adjacent App instances + - name: app-mob-ser + description: Application Mobility Services + - name: app-mob-ser-der + description: Application Mobility Services Deregister task + - name: subscriptions + description: Subscription for Application Mobility Service + +paths: + /app_mobility_services: + get: + tags: + - 'app-mob-ser' + summary: ' Retrieve information about the registered application mobility service.' + description: ' Retrieve information about the registered application mobility service.' + operationId: app_mobility_serviceGET + parameters: + - in: query + name: filter + schema: + type: string + required: false + description: 'Attribute-based filtering parameters according to ETSI GS MEC 011' + - in: query + name: all_fields + schema: + type: string + required: false + description: 'Include all complex attributes in the response.' + - in: query + name: fields + schema: + type: string + required: false + description: 'Complex attributes to be included into the response. See clause 6.18 in ETSI GS MEC 011' + - in: query + name: exclude_fields + schema: + type: string + required: false + description: 'Complex attributes to be excluded from the response.See clause 6.18 in ETSI GS MEC 011' + - in: query + name: exclude_default + schema: + type: string + required: false + description: 'Indicates to exclude the following complex attributes from the response See clause 6.18 in ETSI GS MEC 011 for details.' + responses: + '200': + description: 'Contains in an array the representations of zero or more application mobility services.' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RegistrationInfo' + '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: + - 'app-mob-ser' + summary: 'Create a new application mobility service for the service requester.' + description: 'Create a new application mobility service for the service requester.' + operationId: app_mobility_servicePOST + requestBody: + description: Application mobility service to be created + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/RegistrationInfo' + responses: + '201': + description: Successful response for application mobility service creation + content: + application/json: + schema: + $ref: '#/components/schemas/RegistrationInfo' + '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' + + /app_mobility_services/{appMobilityServiceId}: + parameters: + - in: path + name: appMobilityServiceId + schema: + type: string + required: true + description: 'It uniquely identifies the created individual application mobility service' + get: + tags: + - 'app-mob-ser' + summary: 'Retrieve information about this individual application mobility service' + description: 'Retrieve information about this individual application mobility service' + operationId: app_mobility_service_by_idGET + responses: + '200': + description: 'Contains a representation of the application mobility service.' + + content: + application/json: + schema: + $ref: '#/components/schemas/RegistrationInfo' + '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: + - 'app-mob-ser' + summary: ' update the existing individual application mobility service' + description: ' update the existing individual application mobility service' + operationId: app_mobility_service_by_idPUT + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/RegistrationInfo' + responses: + '200': + description: 'Contains a data type describing the updated application mobility service.' + content: + application/json: + schema: + $ref: '#/components/schemas/RegistrationInfo' + '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: + - 'app-mob-ser' + summary: ' deregister the individual application mobility service' + description: ' deregister the individual application mobility service' + operationId: app_mobility_service_by_idDELETE + 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' + + /app_mobility_services/{appMobilityServiceId}/deregister_task: + parameters: + - in: path + name: appMobilityServiceId + schema: + type: string + description: 'It uniquely identifies the created individual application mobility service' + required: true + post: + tags: + - 'app-mob-ser-der' + summary: ' deregister the individual application mobility service' + description: ' deregister the individual application mobility service' + operationId: app_mobility_service_derPOST + responses: + '204': + $ref: '#/components/responses/204' + '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: + - 'subscriptions' + summary: 'Retrieve information about the subscriptions for this requestor.' + description: 'Retrieve information about the subscriptions for this requestor.' + operationId: subGET + parameters: + - in: query + name: subscriptionType + description: 'Query parameter to filter on a specific subscription type. Permitted values: mobility_proc or adj_app_info' + schema: + type: string + required: true + responses: + '200': + description: 'Contains the list of links to requestor subscriptions.' + 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: + - 'subscriptions' + summary: 'Create a new subscription to Application Mobility Service notifications.' + description: 'Create a new subscription to Application Mobility Service notifications.' + operationId: subPOST + requestBody: + required: true + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/MobilityProcedureSubscription' + - $ref: '#/components/schemas/AdjacentAppInfoSubscription' + responses: + '201': + description: 'Created subscription is described using the appropriate data type' + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/MobilityProcedureSubscription' + - $ref: '#/components/schemas/AdjacentAppInfoSubscription' + '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' + + /subscriptions/{subscriptionId}: + parameters: + - in: path + name: subscriptionId + description: 'Refers to created subscription, where the AMS API allocates a unique resource name for this subscription' + schema: + type: string + required: true + get: + tags: + - 'subscriptions' + summary: 'Retrieve information about this subscription.' + description: 'Retrieve information about this subscription.' + operationId: sub_byIdGET + responses: + '200': + description: 'A response body containing data type describing the specific RNI event subscription' + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/MobilityProcedureSubscription' + - $ref: '#/components/schemas/AdjacentAppInfoSubscription' + '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: + - 'subscriptions' + summary: 'update the existing individual subscription.' + description: 'update the existing individual subscription.' + operationId: sub_byIdPUT + requestBody: + required: true + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/MobilityProcedureSubscription' + - $ref: '#/components/schemas/AdjacentAppInfoSubscription' + responses: + '200': + description: ' a response body containing data type describing the updated subscription' + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/MobilityProcedureSubscription' + - $ref: '#/components/schemas/AdjacentAppInfoSubscription' + '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: + - 'subscriptions' + summary: 'cancel the existing individual subscription' + description: 'cancel the existing individual subscription' + operationId: sub_byIdDELETE + 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' + + +# /notifitication_end_point_provided_by_client +# post: + + /queries/adjacent_app_instances: + get: + tags: + - 'adj-app-inst' + summary: 'Retrieve information about this subscription.' + description: 'Retrieve information about this subscription.' + operationId: adj_app_instGET + parameters: + - in: query + name: filter + schema: + type: string + required: false + description: 'Attribute-based filtering parameters according to ETSI GS MEC 011' + - in: query + name: all_fields + schema: + type: string + required: false + description: 'Include all complex attributes in the response.' + - in: query + name: fields + schema: + type: string + required: false + description: 'Complex attributes to be included into the response. See clause 6.18 in ETSI GS MEC 011' + - in: query + name: exclude_fields + schema: + type: string + required: false + description: 'Complex attributes to be excluded from the response.See clause 6.18 in ETSI GS MEC 011' + - in: query + name: exclude_default + schema: + type: string + required: false + description: 'Indicates to exclude the following complex attributes from the response See clause 6.18 in ETSI GS MEC 011 for details.' + responses: + '200': + description: 'A response body containing zero or more adjacent application instances ' + content: + application/json: + schema: + type: array + minItems: 0 + items: + $ref: '#/components/schemas/AdjacentAppInstanceInfo' + '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' + +components: + schemas: + + AdjacentAppInfoSubscription.links: + description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests. + x-etsi-mec-cardinality: 0..1 + required: + - self + properties: + self: + $ref: '#/components/schemas/LinkType' + + AdjacentAppInfoSubscription.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: 0..1 + properties: + appInstanceId: + type: string + + AdjacentAppInfoSubscription: + properties: + _links: + $ref: '#/components/schemas/AdjacentAppInfoSubscription.links' + callbackReference: + description: URI selected by the service consumer to receive notifications on the subscribed Application Mobility Service. 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/AdjacentAppInfoSubscription.filterCriteria' + #x-etsi-mec-cardinality: '1' + subscriptionType: + description: Shall be set to "AdjacentAppInfoSubscription". + type: string + enum: + - AdjacentAppInfoSubscription + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + required: + - subscriptionType + - callbackReference + - filterCriteria + type: object + x-etsi-ref: 7.3.3 + AdjacentAppInstanceInfo: + properties: + appDId: + description: Identifier of the application descriptor. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + appInstanceCommLink: + description: It specifies the communication interface of application instance. + type: array + items: + $ref: '#/components/schemas/CommunicationInterface' + minItems: 1 + + #x-etsi-mec-cardinality: 1..N + #x-etsi-mec-origin-type: CommunicationInterface + appInstanceId: + description: Identifier of the application instance. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + mecHostInformation: + #description: The MEC host where the application instance is running on. + $ref: '#/components/schemas/MECHostInformation' + #minItems: 1 + + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': MECHostInformation + required: + - appInstanceId + - appDId + - appInstanceCommLink + type: object + x-etsi-ref: 7.2.3 + AppMobilityServiceLevel: + description: This attribute provides an option for the application instance (server) to communicate with the application client before relocating this application instance to another MEC host. + enum: + - APP_MOBILITY_NOT_ALLOWED + - APP_MOBILITY_WITH_CONFIRMATION + - APP_MOBILITY_WITHOUT_CONFIRMATION + type: string + x-etsi-notes: "APP_MOBILITY_NOT_ALLOWED: the current serving application instance continues to deliver the service to the device. The AMS will inform the MEP to perform the traffic steering to the device when the UE moves cross MEC hosts. \u2212 APP_MOBILITY_WITH_CONFIRMATION: the serving application instance is allowed to change with the confirmation by the application once the device mobility happens. The AMS then will inform the MEP to update the traffic routing to the target application instance and clean up the previous resource allocated to the application instance serving to the device after the serving application instance has been changed. \u2212 APP_MOBILITY_WITHOUT_CONFIRMATION: the serving application instance is allowed to change without confirmation from the application instance when the device mobility happens. The AMS will notify to the MEP to update the traffic routing to the target application instance and clean up the previous resource allocated to the application instance serving to the device after the serving application instance has been changed." + CommunicationInterface.IpAddresses: + required: + - host + - port + properties: + host: + type: string + port: + type: integer + + CommunicationInterface: + properties: + ipAddresses: + type: array + items: + $ref: '#/components/schemas/CommunicationInterface.IpAddresses' + + MobilityProcedureSubscription.links: + properties: + self: + # description': Self referring URI. The URI shall be unique within the AMS 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 + + + MobilityProcedureSubscription.filterCriteria: + x-etsi-mec-cardinality: '1' + 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: + appInstanceId: + description: Identifier of the application instance that registers the application mobility service. + type: string + x-etsi-mec-cardinality: 0..1 + #x-etsi-mec-origin-type: String + associateId: + description: 0 to N identifiers to associate the information for specific UE(s) and flow(s). + items: + $ref: '#/components/schemas/AssociateId' + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + #x-etsi-mec-origin-type: AssociateId + mobilityStatus: + description: 'In case mobilityStatus is not included in the subscription request, the default value 1 = INTER_HOST_MOBILITY_TRIGGERED shall be used and included in the response.' + items: + $ref: '#/components/schemas/MobilityStatus' + minItems: 0 + type: array + x-etsi-mec-cardinality: 0..N + + + + MobilityProcedureSubscription: + type: object + x-etsi-ref: 7.3.2 + properties: + + _links: + #description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests. + $ref: '#/components/schemas/MobilityProcedureSubscription.links' + #x-etsi-mec-cardinality: 0..1 + callbackReference: + description: URI selected by the service consumer to receive notifications on the subscribed Application Mobility Service. 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/MobilityProcedureSubscription.filterCriteria' + + subscriptionType: + description: Shall be set to "MobilityProcedureSubscription". + type: string + enum: + - MobilityProcedureSubscription + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + required: + - subscriptionType + - callbackReference + - filterCriteria + + MobilityStatus: + description: Indicate the status of the UE mobility + enum: + - INTERHOST_MOVEOUT_TRIGGERED + - INTERHOST_MOVEOUT_COMPLETED + - INTERHOST_MOVEOUT_FAILED + type: string + + + RegistrationInfo.deviceInformation: + required: + - serviceConsumerId + - associateId + properties: + associateId: + $ref: '#/components/schemas/AssociateId' + # description': Represents the identifier of the device. See note. + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': AssociateId + + appMobilityServiceLevel: + # description': If the application is stateful, this attribute shall be included. + # x-etsi-mec-cardinality': 0..1 + # x-etsi-mec-origin-type': AppMobilityServiceLevel + $ref: '#/components/schemas/AppMobilityServiceLevel' + + contextTransferState: + #description: 'If present, it represents the state of transferring the user context to another application instance.' + #x-etsi-mec-cardinality: 0..N + $ref: '#/components/schemas/contextTransferState' + + RegistrationInfo.serviceConsumerId: + description: The identifier of service consumer requesting the application mobility service, i.e. either the application instance ID or the MEC platform ID. + properties: + appInstanceId: + description: If present, it represents the identifier of the application instance registering the application mobility service. + type: string + x-etsi-mec-cardinality: 0..1 + #x-etsi-mec-origin-type: String + mepId: + description: If present, it represents the identifier of the MEC platform registering the application mobility service. + type: string + x-etsi-mec-cardinality: 0..1 + #x-etsi-mec-origin-type: String + RegistrationInfo: + type: object + properties: + appMobilityServiceId: + description: 'The identifier of registered application mobility service. Shall be absent in POST requests, and present otherwise.' + type: string + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: String + deviceInformation: + description: 'If present, it specifies the device served by the application instance which is registering the application mobility service.' + type: array + minItems: 0 + items: + $ref: '#/components/schemas/RegistrationInfo.deviceInformation' + + expiryTime: + description: 'If present, it indicates the time of application mobility service expiration from the time of registration accepted.The value "0" means infinite time, i.e. no expiration.The unit of expiry time is one second.' + format: Uint32 + type: integer + x-etsi-mec-cardinality: 0..1 + x-etsi-mec-origin-type: Uint32 + serviceConsumerId: + $ref: '#/components/schemas/RegistrationInfo.serviceConsumerId' + required: + - serviceConsumerId + + x-etsi-notes: "NOTE:\tThe data type of AssociateId is defined in ETSI GS MEC 012 [6]." + x-etsi-ref: 7.2.2 + + SubscriptionLinkList.links: + description: List of hyperlinks related to the resource. + properties: + self: + # description': '' + # x-etsi-mec-cardinality': '1' + # x-etsi-mec-origin-type': LinkType + $ref: '#/components/schemas/LinkType' + required: + - self + + SubscriptionLinkList.subscription: + 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: + $ref: '#/components/schemas/subscriptionType' + required: + - href + - subscriptionType + + + SubscriptionLinkList: + properties: + _links: + $ref: '#/components/schemas/SubscriptionLinkList.links' + #x-etsi-mec-cardinality: '1' + + subscription: + description: A link to a subscription. + type: array + minItems: 0 + items: + $ref: '#/components/schemas/SubscriptionLinkList.subscription' + x-etsi-mec-cardinality: 0..N + required: + - _links + x-etsi-ref: 7.3.4 + + contextTransferState: + description: If present, it represents the state of transferring the user context to another application instance. + enum: + - NOT_TRANSFERRED + - USER_CONTEXT_TRANSFER_COMPLETED + type: string + subscriptionType: + description: 'Numeric value (0 - 255) corresponding to specified type of subscription as following: 0 = RESERVED. 1 = MOBILITY_PROCEDURE. 2 = ADJACENT_APPINFO. ' + enum: + - 0 + - 1 + - 2 + type: integer + Seconds: + description: >- + 'The seconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.' + type: integer + format: uint32 + NanoSeconds: + description: >- + 'The nanoseconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.' + type: integer + format: uint32 + HostName: + description: >- + Human-readable name of MEC host. + type: string + KeyValuePairs: + description: >- + 'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259' + type: object + additionalProperties: true + + AssociateId: + properties: + type: + description: 'Numeric value (0-255) corresponding to specified type of identifier' + enum: + - UE_IPv4_ADDRESS + - UE_IPV6_ADDRESS + - NATED_IP_ADDRESS + - GTP_TEID + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: Enum + value: + description: Value for the identifier. + type: string + x-etsi-mec-cardinality: '1' + x-etsi-mec-origin-type: String + required: + - type + - value + type: object + x-etsi-ref: 6.5.4 + 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 + TimeStamp: + description: >- + 'This data type represents the time stamp as Unix-time since January 1, 1970, 00:00:00 UTC' + type: object + required: + - seconds + - nanoSeconds + properties: + seconds: + $ref: '#/components/schemas/Seconds' + nanoSeconds: + $ref: '#/components/schemas/NanoSeconds' + MECHostInformation: + description: >- + 'The data type represents the parameters of MEC host information.' + type: object + required: + - hostId + properties: + hostName: + $ref: '#/components/schemas/HostName' + hostId: + $ref: '#/components/schemas/KeyValuePairs' + + + + 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 + responses: + 204: + description: No Content + 206: + description: Partial content + 400: + description: 'Bad Request : used to indicate that incorrect parameters were passed to the request.' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + 401: + description: 'Unauthorized : used when the client did not submit credentials.' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + 403: + description: 'Forbidden : operation is not allowed given the current status of the resource.' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + 404: + description: 'Not Found : used when a client provided a URI that cannot be mapped to a valid resource URI.' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + 406: + description: 'Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + 409: + description: 'Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + 412: + description: 'Precondition failed : used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + 415: + description: 'Unsupported Media Type : used to indicate that the server or the client does not support the content type of the entity body.' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + 422: + description: 'Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + 429: + description: 'Too Many Requests : used when a rate limiter has triggered.' + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' \ No newline at end of file diff --git a/README.md b/README.md index 9f84e70a9e39bde14d69060caf2536a415077d9c..44ea4f93eeb212a752924a27268c212348833a8d 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,15 @@ This repository contains OpenAPIs descriptions for the interfaces specified in ETSI GS MEC 021. +## Online resources + +* [Specification document](https://www.etsi.org/deliver/etsi_gs/MEC/001_099/021/02.01.01_60/gs_mec021v020101p.pdf) +* [Navigate the Application Mobility Service API in the browser](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/mec/gs021-amsi-api/raw/develop/MEC021_AppMobilityService.yaml). +* [Edit the Application Mobility Service API online](https://forge.etsi.org/swagger/editor/?url=https://forge.etsi.org/rep/mec/gs021-amsi-api/raw/develop/MEC021_AppMobilityService.yaml). + ## 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. + + diff --git a/proto3/models/adjacent_app_info_subscription.proto b/proto3/models/adjacent_app_info_subscription.proto new file mode 100644 index 0000000000000000000000000000000000000000..a322964fde1a5f85cf6e2c4cd0fadc2631ce3ce6 --- /dev/null +++ b/proto3/models/adjacent_app_info_subscription.proto @@ -0,0 +1,35 @@ +/* + ETSI GS MEC 021 Application Mobility Service API + + ETSI GS MEC 021 Application Mobility Service API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec021; + +import public "models/adjacent_app_info_subscription_filter_criteria.proto"; +import public "models/adjacent_app_info_subscription_links.proto"; +import public "models/time_stamp.proto"; + +message AdjacentAppInfoSubscription { + + AdjacentAppInfoSubscriptionLinks underscorelinks = 1; + + // URI selected by the service consumer to receive notifications on the subscribed Application Mobility Service. This shall be included both in the request and in response. + string callback_reference = 2; + + TimeStamp expiry_deadline = 3; + + AdjacentAppInfoSubscriptionFilterCriteria filter_criteria = 4; + + // Shall be set to \"AdjacentAppInfoSubscription\". + enum SUBSCRIPTION_TYPE { + ADJACENTAPPINFOSUBSCRIPTION = 0; + } + +} diff --git a/proto3/models/adjacent_app_info_subscription_filter_criteria.proto b/proto3/models/adjacent_app_info_subscription_filter_criteria.proto new file mode 100644 index 0000000000000000000000000000000000000000..d4dfa74b7ed9cc895f14200576f1e494b04e55a5 --- /dev/null +++ b/proto3/models/adjacent_app_info_subscription_filter_criteria.proto @@ -0,0 +1,20 @@ +/* + ETSI GS MEC 021 Application Mobility Service API + + ETSI GS MEC 021 Application Mobility Service API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec021; + + +message AdjacentAppInfoSubscriptionFilterCriteria { + + string app_instance_id = 1; + +} diff --git a/proto3/models/adjacent_app_info_subscription_links.proto b/proto3/models/adjacent_app_info_subscription_links.proto new file mode 100644 index 0000000000000000000000000000000000000000..ddcc8e665f692f73adf53c76405cadc442b54c6a --- /dev/null +++ b/proto3/models/adjacent_app_info_subscription_links.proto @@ -0,0 +1,21 @@ +/* + ETSI GS MEC 021 Application Mobility Service API + + ETSI GS MEC 021 Application Mobility Service API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec021; + +import public "models/link_type.proto"; + +message AdjacentAppInfoSubscriptionLinks { + + LinkType self = 1; + +} diff --git a/proto3/models/adjacent_app_instance_info.proto b/proto3/models/adjacent_app_instance_info.proto new file mode 100644 index 0000000000000000000000000000000000000000..cfd3c61d0c3a0857db245a7fbe6a79e949dfcbb1 --- /dev/null +++ b/proto3/models/adjacent_app_instance_info.proto @@ -0,0 +1,31 @@ +/* + ETSI GS MEC 021 Application Mobility Service API + + ETSI GS MEC 021 Application Mobility Service API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec021; + +import public "models/communication_interface.proto"; +import public "models/mec_host_information.proto"; + +message AdjacentAppInstanceInfo { + + // Identifier of the application descriptor. + string appd_id = 1; + + // It specifies the communication interface of application instance. + repeated CommunicationInterface app_instance_comm_link = 2; + + // Identifier of the application instance. + string app_instance_id = 3; + + MECHostInformation mec_host_information = 4; + +} diff --git a/proto3/models/app_mobility_service_level.proto b/proto3/models/app_mobility_service_level.proto new file mode 100644 index 0000000000000000000000000000000000000000..9035648bcc8081ce7216f653d307d61fcbe8a94d --- /dev/null +++ b/proto3/models/app_mobility_service_level.proto @@ -0,0 +1,28 @@ +/* + ETSI GS MEC 021 Application Mobility Service API + + ETSI GS MEC 021 Application Mobility Service API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec021; + + +//This attribute provides an option for the application instance (server) to communicate with the application client before relocating this application instance to another MEC host. The applicable values of this attribute are: 1 = APP_MOBILITY_NOT_ALLOWED 2 = APP_MOBILITY_WITH_CONFIRMATION 3 = APP_MOBILITY_WITHOUT_CONFIRMATION. +message AppMobilityServiceLevel { + enum TypeEnum { + APP_MOBILITY_SERVICE_LEVEL_TYPE_ENUM_1 = 0; + APP_MOBILITY_SERVICE_LEVEL_TYPE_ENUM_2 = 1; + APP_MOBILITY_SERVICE_LEVEL_TYPE_ENUM_3 = 2; + } + TypeEnum type = 1; + + // Value for the identifier. + string value = 2; + +} diff --git a/proto3/models/associate_id.proto b/proto3/models/associate_id.proto new file mode 100644 index 0000000000000000000000000000000000000000..3ab23cca111bad986cf54882cca302882063b3e5 --- /dev/null +++ b/proto3/models/associate_id.proto @@ -0,0 +1,32 @@ +/* + ETSI GS MEC 021 Application Mobility Service API + + ETSI GS MEC 021 Application Mobility Service API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec021; + + +message AssociateId { + + // Numeric value (0-255) corresponding to specified type of identifier as following:

0 = reserved.

1 = UE_IPv4_ADDRESS.

2 = UE_IPV6_ADDRESS.

3 = NATED_IP_ADDRESS.

4 = GTP_TEID. + enum TypeEnum { + ASSOCIATE_ID_TYPE_ENUM_0 = 0; + ASSOCIATE_ID_TYPE_ENUM_1 = 1; + ASSOCIATE_ID_TYPE_ENUM_2 = 2; + ASSOCIATE_ID_TYPE_ENUM_3 = 3; + ASSOCIATE_ID_TYPE_ENUM_4 = 4; + } + + TypeEnum type = 1; + + // Value for the identifier. + string value = 2; + +} diff --git a/proto3/models/communication_interface.proto b/proto3/models/communication_interface.proto new file mode 100644 index 0000000000000000000000000000000000000000..2cb625a312102669fae4c45381a215cac225cb15 --- /dev/null +++ b/proto3/models/communication_interface.proto @@ -0,0 +1,21 @@ +/* + ETSI GS MEC 021 Application Mobility Service API + + ETSI GS MEC 021 Application Mobility Service API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec021; + +import public "models/communication_interface_ip_addresses.proto"; + +message CommunicationInterface { + + repeated CommunicationInterfaceIpAddresses ip_addresses = 1; + +} diff --git a/proto3/models/communication_interface_ip_addresses.proto b/proto3/models/communication_interface_ip_addresses.proto new file mode 100644 index 0000000000000000000000000000000000000000..b3fcbaf4e302b4c79ae7dc0780ad08e01a2d9ca7 --- /dev/null +++ b/proto3/models/communication_interface_ip_addresses.proto @@ -0,0 +1,22 @@ +/* + ETSI GS MEC 021 Application Mobility Service API + + ETSI GS MEC 021 Application Mobility Service API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec021; + + +message CommunicationInterfaceIpAddresses { + + string host = 1; + + int32 port = 2; + +} diff --git a/proto3/models/context_transfer_state.proto b/proto3/models/context_transfer_state.proto new file mode 100644 index 0000000000000000000000000000000000000000..dfc4f15bc8e1df3939bdcd10e4f8ec0a328e74c0 --- /dev/null +++ b/proto3/models/context_transfer_state.proto @@ -0,0 +1,28 @@ +/* + ETSI GS MEC 021 Application Mobility Service API + + ETSI GS MEC 021 Application Mobility Service API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec021; + +//If present, it represents the state of transferring the user context to another application instance. The applicable values of this attribute are: 0 = NOT_TRANSFERRED (default value) 1 = USER_CONTEXT_TRANSFER_COMPLETED In the initial application mobility registration, this attribute shall be set to the default value. + +message ContextTransferState{ +enum TypeEnum { + CONTEXT_TRANSFER_STATE_TYPE_ENUM_0 = 0; + CONTEXT_TRANSFER_STATE_TYPE_ENUM_1 = 1; + } + + TypeEnum type = 1; + + // Value for the identifier. + string value = 2; +} + diff --git a/proto3/models/link_type.proto b/proto3/models/link_type.proto new file mode 100644 index 0000000000000000000000000000000000000000..5f41ecc1b0abf8dfb3ee0e00857b278b47fa5a82 --- /dev/null +++ b/proto3/models/link_type.proto @@ -0,0 +1,21 @@ +/* + ETSI GS MEC 021 Application Mobility Service API + + ETSI GS MEC 021 Application Mobility Service API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec021; + + +message LinkType { + + // The URI referring to the subscription. + string href = 1; + +} diff --git a/proto3/models/mec_host_information.proto b/proto3/models/mec_host_information.proto new file mode 100644 index 0000000000000000000000000000000000000000..f4849315c43a1c9cad23ba0fd342cf77c5a94194 --- /dev/null +++ b/proto3/models/mec_host_information.proto @@ -0,0 +1,24 @@ +/* + ETSI GS MEC 021 Application Mobility Service API + + ETSI GS MEC 021 Application Mobility Service API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec021; +import "google/protobuf/any.proto"; + +message MECHostInformation { + + // Human-readable name of MEC host. + string host_name = 1; + + // 'This data type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key-value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 8259' + map host_id = 2; + +} diff --git a/proto3/models/mobility_procedure_subscription.proto b/proto3/models/mobility_procedure_subscription.proto new file mode 100644 index 0000000000000000000000000000000000000000..46e3222af29383f4ec8e19fc79f173763016994a --- /dev/null +++ b/proto3/models/mobility_procedure_subscription.proto @@ -0,0 +1,35 @@ +/* + ETSI GS MEC 021 Application Mobility Service API + + ETSI GS MEC 021 Application Mobility Service API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec021; + +import public "models/mobility_procedure_subscription_filter_criteria.proto"; +import public "models/mobility_procedure_subscription_links.proto"; +import public "models/time_stamp.proto"; + +message MobilityProcedureSubscription { + + MobilityProcedureSubscriptionLinks underscorelinks = 1; + + // URI selected by the service consumer to receive notifications on the subscribed Application Mobility Service. This shall be included both in the request and in response. + string callback_reference = 2; + + TimeStamp expiry_deadline = 3; + + MobilityProcedureSubscriptionFilterCriteria filter_criteria = 4; + + // Shall be set to \"MobilityProcedureSubscription\". + enum subscriptionType { + MOBILITYPROCEDURESUBSCRIPTION = 0; + } + +} diff --git a/proto3/models/mobility_procedure_subscription_filter_criteria.proto b/proto3/models/mobility_procedure_subscription_filter_criteria.proto new file mode 100644 index 0000000000000000000000000000000000000000..6ae194b3f2cbab3ccc4fc9783832ebcfc62d6e8f --- /dev/null +++ b/proto3/models/mobility_procedure_subscription_filter_criteria.proto @@ -0,0 +1,29 @@ +/* + ETSI GS MEC 021 Application Mobility Service API + + ETSI GS MEC 021 Application Mobility Service API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec021; + +import public "models/associate_id.proto"; +import public "models/mobility_status.proto"; + +message MobilityProcedureSubscriptionFilterCriteria { + + // Identifier of the application instance that registers the application mobility service. + string app_instance_id = 1; + + // 0 to N identifiers to associate the information for specific UE(s) and flow(s). + repeated AssociateId associate_id = 2; + + // In case mobility_status is not included in the subscription request, the default value 1 = INTER_HOST_MOBILITY_TRIGGERED shall be used and included in the response. + repeated MobilityStatus mobility_status = 3; + +} diff --git a/proto3/models/mobility_procedure_subscription_links.proto b/proto3/models/mobility_procedure_subscription_links.proto new file mode 100644 index 0000000000000000000000000000000000000000..6810086d404bff4639f06e26ea92da975445e846 --- /dev/null +++ b/proto3/models/mobility_procedure_subscription_links.proto @@ -0,0 +1,21 @@ +/* + ETSI GS MEC 021 Application Mobility Service API + + ETSI GS MEC 021 Application Mobility Service API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec021; + +import public "models/link_type.proto"; + +message MobilityProcedureSubscriptionLinks { + + LinkType self = 1; + +} diff --git a/proto3/models/mobility_status.proto b/proto3/models/mobility_status.proto new file mode 100644 index 0000000000000000000000000000000000000000..1bf0b75d84b14463b01f66a93c862be58b80c91c --- /dev/null +++ b/proto3/models/mobility_status.proto @@ -0,0 +1,28 @@ +/* + ETSI GS MEC 021 Application Mobility Service API + + ETSI GS MEC 021 Application Mobility Service API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec021; + +//In case mobilityStatus is not included in the subscription request, the default value 1 = INTER_HOST_MOBILITY_TRIGGERED shall be used and included in the response. 1 = INTERHOST_MOVEOUT_TRIGGERED. 2 = INTERHOST_MOVEOUT_COMPLETED. 3 = INTERHOST_MOVEOUT_FAILED. +message MobilityStatus{ + enum TypeEnum { + MOBILITY_STATUS_TYPE_ENUM_1 = 0; + MOBILITY_STATUS_TYPE_ENUM_2 = 1; + MOBILITY_STATUS_TYPE_ENUM_3 = 2; + } + TypeEnum type = 1; + + // Value for the identifier. + string value = 2; + +} + diff --git a/proto3/models/problem_details.proto b/proto3/models/problem_details.proto new file mode 100644 index 0000000000000000000000000000000000000000..ebf67016e77b5081cd74819f46cb6b341c900f91 --- /dev/null +++ b/proto3/models/problem_details.proto @@ -0,0 +1,33 @@ +/* + ETSI GS MEC 021 Application Mobility Service API + + ETSI GS MEC 021 Application Mobility Service API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec021; + + +message ProblemDetails { + + // A human-readable explanation specific to this occurrence of the problem + string detail = 1; + + // A URI reference that identifies the specific occurrence of the problem + string instance = 2; + + // The HTTP status code for this occurrence of the problem + int32 status = 3; + + // A short, human-readable summary of the problem type + string title = 4; + + // A URI reference according to IETF RFC 3986 that identifies the problem type + string type = 5; + +} diff --git a/proto3/models/registration_info.proto b/proto3/models/registration_info.proto new file mode 100644 index 0000000000000000000000000000000000000000..13acb497a7568d956aa27b28d4be32ed68d8f4eb --- /dev/null +++ b/proto3/models/registration_info.proto @@ -0,0 +1,31 @@ +/* + ETSI GS MEC 021 Application Mobility Service API + + ETSI GS MEC 021 Application Mobility Service API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec021; + +import public "models/registration_info_device_information.proto"; +import public "models/registration_info_service_consumer_id.proto"; + +message RegistrationInfo { + + // The identifier of registered application mobility service. Shall be absent in POST requests, and present otherwise. + string app_mobility_service_id = 1; + + // If present, it specifies the device served by the application instance which is registering the application mobility service. + repeated RegistrationInfoDeviceInformation device_information = 2; + + // If present, it indicates the time of application mobility service expiration from the time of registration accepted.The value \"0\" means infinite time, i.e. no expiration.The unit of expiry time is one second. + int32 expiry_time = 3; + + RegistrationInfoServiceConsumerId service_consumer_id = 4; + +} diff --git a/proto3/models/registration_info_device_information.proto b/proto3/models/registration_info_device_information.proto new file mode 100644 index 0000000000000000000000000000000000000000..0a7b3bbff2e541c4959cb3d3cb9b8dac4c9af5b6 --- /dev/null +++ b/proto3/models/registration_info_device_information.proto @@ -0,0 +1,27 @@ +/* + ETSI GS MEC 021 Application Mobility Service API + + ETSI GS MEC 021 Application Mobility Service API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec021; + +import public "models/app_mobility_service_level.proto"; +import public "models/associate_id.proto"; +import public "models/context_transfer_state.proto"; + +message RegistrationInfoDeviceInformation { + + AssociateId associate_id = 1; + + AppMobilityServiceLevel app_mobility_service_level = 2; + + ContextTransferState context_transfer_state = 3; + +} diff --git a/proto3/models/registration_info_service_consumer_id.proto b/proto3/models/registration_info_service_consumer_id.proto new file mode 100644 index 0000000000000000000000000000000000000000..2fe200f4f0c504ccaa0a9375f4cc9037a41b16f3 --- /dev/null +++ b/proto3/models/registration_info_service_consumer_id.proto @@ -0,0 +1,24 @@ +/* + ETSI GS MEC 021 Application Mobility Service API + + ETSI GS MEC 021 Application Mobility Service API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec021; + + +message RegistrationInfoServiceConsumerId { + + // If present, it represents the identifier of the application instance registering the application mobility service. + string app_instance_id = 1; + + // If present, it represents the identifier of the MEC platform registering the application mobility service. + string mep_id = 2; + +} diff --git a/proto3/models/subscription.proto b/proto3/models/subscription.proto new file mode 100644 index 0000000000000000000000000000000000000000..1b1628d9f63f3e47c512bb7f0ed05c2ed1acb3d2 --- /dev/null +++ b/proto3/models/subscription.proto @@ -0,0 +1,23 @@ +/* + ETSI GS MEC 021 Application Mobility Service API + + ETSI GS MEC 021 Application Mobility Service API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec021; + +import public "models/mobility_procedure_subscription.proto"; +import public "models/adjacent_app_info_subscription.proto"; + +message Subscription { + oneof subscription { + MobilityProcedureSubscription mobility_procedure_subscription = 1; + AdjacentAppInfoSubscription adjacent_app_info_subscription = 2; + } +} diff --git a/proto3/models/subscription_link_list.proto b/proto3/models/subscription_link_list.proto new file mode 100644 index 0000000000000000000000000000000000000000..2a8b058b9ce888b545feba7e9382dfaf0bd28a7a --- /dev/null +++ b/proto3/models/subscription_link_list.proto @@ -0,0 +1,25 @@ +/* + ETSI GS MEC 021 Application Mobility Service API + + ETSI GS MEC 021 Application Mobility Service API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec021; + +import public "models/subscription_link_list_links.proto"; +import public "models/subscription_link_list_subscription.proto"; + +message SubscriptionLinkList { + + SubscriptionLinkListLinks underscorelinks = 1; + + // A link to a subscription. + repeated SubscriptionLinkListSubscription subscription = 2; + +} diff --git a/proto3/models/subscription_link_list_links.proto b/proto3/models/subscription_link_list_links.proto new file mode 100644 index 0000000000000000000000000000000000000000..b1cb3c4f841708ccfe3751abc7b482ac0b3d9132 --- /dev/null +++ b/proto3/models/subscription_link_list_links.proto @@ -0,0 +1,21 @@ +/* + ETSI GS MEC 021 Application Mobility Service API + + ETSI GS MEC 021 Application Mobility Service API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec021; + +import public "models/link_type.proto"; + +message SubscriptionLinkListLinks { + + LinkType self = 1; + +} diff --git a/proto3/models/subscription_link_list_subscription.proto b/proto3/models/subscription_link_list_subscription.proto new file mode 100644 index 0000000000000000000000000000000000000000..1519076e22b183e08deb8d9debed1297e9321706 --- /dev/null +++ b/proto3/models/subscription_link_list_subscription.proto @@ -0,0 +1,24 @@ +/* + ETSI GS MEC 021 Application Mobility Service API + + ETSI GS MEC 021 Application Mobility Service API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec021; + +import public "models/subscription_type.proto"; + +message SubscriptionLinkListSubscription { + + // The URI referring to the subscription. + string href = 1; + + SubscriptionType subscription_type = 2; + +} diff --git a/proto3/models/subscription_type.proto b/proto3/models/subscription_type.proto new file mode 100644 index 0000000000000000000000000000000000000000..575576d20f4a5c951697299ee0aee42ca6856c89 --- /dev/null +++ b/proto3/models/subscription_type.proto @@ -0,0 +1,28 @@ +/* + ETSI GS MEC 021 Application Mobility Service API + + ETSI GS MEC 021 Application Mobility Service API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec021; + +//Numeric value (0 - 255) corresponding to specified type of subscription as following: 0 = RESERVED. 1 = MOBILITY_PROCEDURE. 2 = ADJACENT_APPINFO. +message SubscriptionType{ +enum TypeEnum { + SUBSCRIPTION_TYPE_TYPE_ENUM_0 = 0; + SUBSCRIPTION_TYPE_TYPE_ENUM_1 = 1; + SUBSCRIPTION_TYPE_TYPE_ENUM_2 = 2; + } + + TypeEnum type = 1; + + // Value for the identifier. + string value = 2; + +} diff --git a/proto3/models/time_stamp.proto b/proto3/models/time_stamp.proto new file mode 100644 index 0000000000000000000000000000000000000000..8829ce09d4c84f326f516d0eefc787a49c4ba5fa --- /dev/null +++ b/proto3/models/time_stamp.proto @@ -0,0 +1,24 @@ +/* + ETSI GS MEC 021 Application Mobility Service API + + ETSI GS MEC 021 Application Mobility Service API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec021; + + +message TimeStamp { + + // 'The seconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.' + int32 seconds = 1; + + // 'The nanoseconds part of the Time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.' + int32 nano_seconds = 2; + +} diff --git a/proto3/services/adj_app_inst_service.proto b/proto3/services/adj_app_inst_service.proto new file mode 100644 index 0000000000000000000000000000000000000000..244b683d48deffe884d390f44e2de9730c9f7e76 --- /dev/null +++ b/proto3/services/adj_app_inst_service.proto @@ -0,0 +1,41 @@ +/* + ETSI GS MEC 021 Application Mobility Service API + + ETSI GS MEC 021 Application Mobility Service API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec021; + + +import public "models/adjacent_app_instance_info.proto"; +import public "models/problem_details.proto"; + +service AdjAppInstService { + rpc AdjAppInstGET (AdjAppInstGETRequest) returns (AdjAppInstGETResponse); + +} + +message AdjAppInstGETRequest { + // Attribute-based filtering parameters according to ETSI GS MEC 011 + string filter = 1; + // Include all complex attributes in the response. + string all_fields = 2; + // Complex attributes to be included into the response. See clause 6.18 in ETSI GS MEC 011 + string fields = 3; + // Complex attributes to be excluded from the response.See clause 6.18 in ETSI GS MEC 011 + string exclude_fields = 4; + // Indicates to exclude the following complex attributes from the response See clause 6.18 in ETSI GS MEC 011 for details. + string exclude_default = 5; + +} + +message AdjAppInstGETResponse { + repeated AdjacentAppInstanceInfo data = 1; +} + diff --git a/proto3/services/app_mob_ser_der_service.proto b/proto3/services/app_mob_ser_der_service.proto new file mode 100644 index 0000000000000000000000000000000000000000..9194d23415c115a8df6e523adac903d69dda0f9a --- /dev/null +++ b/proto3/services/app_mob_ser_der_service.proto @@ -0,0 +1,27 @@ +/* + ETSI GS MEC 021 Application Mobility Service API + + ETSI GS MEC 021 Application Mobility Service API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec021; + +import "google/protobuf/empty.proto"; +import public "models/problem_details.proto"; + +service AppMobSerDerService { + rpc AppMobilityServiceDerPOST (AppMobilityServiceDerPOSTRequest) returns (google.protobuf.Empty); + +} + +message AppMobilityServiceDerPOSTRequest { + string app_mobility_service_id = 1; + +} + diff --git a/proto3/services/app_mob_ser_service.proto b/proto3/services/app_mob_ser_service.proto new file mode 100644 index 0000000000000000000000000000000000000000..251b55815183c8effb9ab7a66a9cfec62401d2b7 --- /dev/null +++ b/proto3/services/app_mob_ser_service.proto @@ -0,0 +1,74 @@ +/* + ETSI GS MEC 021 Application Mobility Service API + + ETSI GS MEC 021 Application Mobility Service API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec021; + +import "google/protobuf/empty.proto"; +import public "models/problem_details.proto"; +import public "models/registration_info.proto"; + +service AppMobSerService { + rpc AppMobilityServiceByIdDELETE (AppMobilityServiceByIdDELETERequest) returns (google.protobuf.Empty); + + rpc AppMobilityServiceByIdGET (AppMobilityServiceByIdGETRequest) returns (RegistrationInfo); + + rpc AppMobilityServiceByIdPUT (AppMobilityServiceByIdPUTRequest) returns (RegistrationInfo); + + rpc AppMobilityServiceGET (AppMobilityServiceGETRequest) returns (AppMobilityServiceGETResponse); + + rpc AppMobilityServicePOST (AppMobilityServicePOSTRequest) returns (RegistrationInfo); + +} + +message AppMobilityServiceByIdDELETERequest { + // Identifier of the created individual application mobility service. + string app_mobility_service_id = 1; + +} + +message AppMobilityServiceByIdGETRequest { + // Identifier of the created individual application mobility service. + string app_mobility_service_id = 1; + +} + +message AppMobilityServiceByIdPUTRequest { + // Identifier of the created individual application mobility service. + string app_mobility_service_id = 1; + RegistrationInfo registration_info = 2; + +} + +message AppMobilityServiceGETRequest { + // Attribute-based filtering parameters according to ETSI GS MEC 011 + string filter = 1; + // Include all complex attributes in the response. + string all_fields = 2; + // Complex attributes to be included into the response. See clause 6.18 in ETSI GS MEC 011 + string fields = 3; + // Complex attributes to be excluded from the response.See clause 6.18 in ETSI GS MEC 011 + string exclude_fields = 4; + // Indicates to exclude the following complex attributes from the response See clause 6.18 in ETSI GS MEC 011 for details. + string exclude_default = 5; + +} + +message AppMobilityServiceGETResponse { + repeated RegistrationInfo data = 1; +} + +message AppMobilityServicePOSTRequest { + // Application mobility service to be created + RegistrationInfo registration_info = 1; + +} + diff --git a/proto3/services/subscriptions_service.proto b/proto3/services/subscriptions_service.proto new file mode 100644 index 0000000000000000000000000000000000000000..bb8db6965a946c0f6b087b523620664f08c1fe86 --- /dev/null +++ b/proto3/services/subscriptions_service.proto @@ -0,0 +1,58 @@ +/* + ETSI GS MEC 021 Application Mobility Service API + + ETSI GS MEC 021 Application Mobility Service API described using OpenAPI. + + The version of the OpenAPI document: 2.1.1 + + Generated by OpenAPI Generator: https://openapi-generator.tech +*/ + +syntax = "proto3"; + +package mec021; + +import "google/protobuf/empty.proto"; +import public "models/problem_details.proto"; +import public "models/subscription_link_list.proto"; +import public "models/subscription.proto"; + +service SubscriptionsService { + rpc SubByIdDELETE (SubByIdDELETERequest) returns (google.protobuf.Empty); + + rpc SubByIdGET (SubByIdGETRequest) returns (Subscription); + + rpc SubByIdPUT (SubByIdPUTRequest) returns (Subscription); + + rpc SubGET (SubGETRequest) returns (SubscriptionLinkList); + + rpc SubPOST (SubPOSTRequest) returns (Subscription); + +} + +message SubByIdDELETERequest { + string subscription_id = 1; + +} + +message SubByIdGETRequest { + string subscription_id = 1; + +} + +message SubByIdPUTRequest { + string subscription_id = 1; + Subscription subscription = 2; + +} + +message SubGETRequest { + string subscription_type = 1; + +} + +message SubPOSTRequest { + Subscription subscription = 1; + +} +