Skip to content

GitLab

Commit b409f1b8 authored by Walter Featherstone's avatar Walter Featherstone
Browse files

Updated to align with GS MEC-011 v2.0.9

parent 2b024cda
Pipeline #1126 passed with stage
in 0 seconds
Hide whitespace changes
Inline Side-by-side
Showing with 1714 additions and 3382 deletions
Mp1.json → MecAppSupportApi.json
View file @ b409f1b8
......@@ -2,16 +2,16 @@
"openapi": "3.0.2",
"servers": [
{
"url": "http://127.0.0.1:8081/mp1/v1"
"url": "http://127.0.0.1:8081/mec_app_support/v1"
},
{
"url": "https://127.0.0.1:8081/mp1/v1"
"url": "https://127.0.0.1:8081/mec_app_support/v1"
}
],
"info": {
"title": "Mp1 API",
"version": "2.0.8",
"description": "The ETSI MEC ISG MEC011 Application Enablement API described using OpenAPI",
"title": "MEC Application Support API",
"version": "2.0.9",
"description": "The ETSI MEC ISG MEC011 MEC Application Support API described using OpenAPI",
"license": {
"name": "ETSI Forge copyright notice",
"url": "https://forge.etsi.org/etsi-forge-copyright-notice.txt"
......@@ -21,8 +21,8 @@
}
},
"externalDocs": {
"description": "ETSI GS MEC011 Application Enablement API, V2.0.8",
"url": "https://docbox.etsi.org/ISG/MEC/70-Draft/0011v211Plat.App.Enabl/MEC-0011v211Plat.App.Enablv208.zip"
"description": "ETSI GS MEC011 Application Enablement API, V2.0.9",
"url": "https://docbox.etsi.org/ISG/MEC/70-Draft/0011v211Plat.App.Enabl/MEC-0011v211Plat.App.Enablv209.zip"
},
"tags": [
{
......@@ -37,72 +37,29 @@
{
"name": "appConfirmTermination"
},
{
"name": "appServices"
},
{
"name": "services"
},
{
"name": "timing"
},
{
"name": "transports"
},
{
"name": "callbacks"
}
],
"paths": {
"/applications/{appInstanceId}/confirm_termination": {
"parameters": [
{
"$ref": "#/components/parameters/Path.AppInstanceId"
}
],
"post": {
"description": "This method is used to confirm the application level termination of an application instance.",
"operationId": "ApplicationsConfirmTermination_POST",
"tags": [
"appConfirmTermination"
],
"responses": {
"204": {
"description": "No Content"
},
"401": {
"$ref": "#/components/responses/Error.401"
},
"403": {
"$ref": "#/components/responses/Error.403"
},
"404": {
"$ref": "#/components/responses/Error.404"
},
"409": {
"$ref": "#/components/responses/Error.409"
},
"429": {
"$ref": "#/components/responses/Error.429"
}
}
}
},
"/applications/{appInstanceId}/dns_rules": {
"/applications/{appInstanceId}/traffic_rules": {
"parameters": [
{
"$ref": "#/components/parameters/Path.AppInstanceId"
}
],
"get": {
"description": "This method retrieves information about all the DNS rules associated with a mobile edge application instance.",
"operationId": "ApplicationsDnsRules_GET",
"description": "This method retrieves information about all the traffic rules associated with a MEC application instance.",
"operationId": "ApplicationsTrafficRules_GET",
"tags": [
"appDnsRules"
"appTrafficRules"
],
"responses": {
"200": {
"$ref": "#/components/responses/ApplicationsDnsRules.200"
"$ref": "#/components/responses/ApplicationsTrafficRules.200"
},
"400": {
"$ref": "#/components/responses/Error.400"
......@@ -116,24 +73,24 @@
}
}
},
"/applications/{appInstanceId}/dns_rules/{dnsRuleId}": {
"/applications/{appInstanceId}/traffic_rules/{trafficRuleId}": {
"parameters": [
{
"$ref": "#/components/parameters/Path.AppInstanceId"
},
{
"$ref": "#/components/parameters/Path.DnsRuleId"
"$ref": "#/components/parameters/Path.TrafficRuleId"
}
],
"get": {
"description": "This method retrieves information about a DNS rule associated with a mobile edge application instance.",
"operationId": "ApplicationsDnsRule_GET",
"description": "This method retrieves information about all the traffic rules associated with a MEC application instance.",
"operationId": "ApplicationsTrafficRule_GET",
"tags": [
"appDnsRules"
"appTrafficRules"
],
"responses": {
"200": {
"$ref": "#/components/responses/ApplicationsDnsRule.200"
"$ref": "#/components/responses/ApplicationsTrafficRule.200"
},
"400": {
"$ref": "#/components/responses/Error.400"
......@@ -147,14 +104,14 @@
}
},
"put": {
"description": "This method activates, de-activates or updates a traffic rule.",
"operationId": "ApplicationsDnsRule_PUT",
"description": "This method retrieves information about all the traffic rules associated with a MEC application instance.",
"operationId": "ApplicationsTrafficRule_PUT",
"tags": [
"appDnsRules"
"appTrafficRules"
],
"responses": {
"200": {
"$ref": "#/components/responses/ApplicationsDnsRule.200"
"$ref": "#/components/responses/ApplicationsTrafficRule.200"
},
"400": {
"$ref": "#/components/responses/Error.400"
......@@ -170,134 +127,25 @@
}
},
"requestBody": {
"$ref": "#/components/requestBodies/ApplicationsDnsRule"
}
}
},
"/applications/{appInstanceId}/subscriptions": {
"parameters": [
{
"$ref": "#/components/parameters/Path.AppInstanceId"
}
],
"get": {
"description": "The GET method may be used to request information about all subscriptions for this requestor. Upon success, the response contains entity body with all the subscriptions for the requestor.",
"operationId": "ApplicationsSubscriptions_GET",
"tags": [
"appSubscriptions"
],
"responses": {
"200": {
"$ref": "#/components/responses/ApplicationsSubscriptions.200"
},
"400": {
"$ref": "#/components/responses/Error.400"
},
"403": {
"$ref": "#/components/responses/Error.403"
},
"404": {
"$ref": "#/components/responses/Error.404"
}
}
},
"post": {
"description": "The POST method may be used to create a new subscription. One example use case is to create a new subscription to the mobile edge service availability notifications. Upon success, the response contains entity body describing the created subscription.",
"operationId": "ApplicationsSubscriptions_POST",
"tags": [
"appSubscriptions"
],
"responses": {
"201": {
"$ref": "#/components/responses/ApplicationsSubscriptions.201"
},
"400": {
"$ref": "#/components/responses/Error.400"
},
"403": {
"$ref": "#/components/responses/Error.403"
},
"404": {
"$ref": "#/components/responses/Error.404"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/ApplicationsSubscriptions"
},
"callbacks": {
"appTerminationNotification": {
"$ref": "#/components/callbacks/AppTerminationNotification"
},
"serviceAvailabilityNotification": {
"$ref": "#/components/callbacks/ServiceAvailabilityNotification"
}
}
}
},
"/applications/{appInstanceId}/subscriptions/{subscriptionId}": {
"parameters": [
{
"$ref": "#/components/parameters/Path.AppInstanceId"
},
{
"$ref": "#/components/parameters/Path.SubscriptionId"
}
],
"get": {
"description": "The GET method requests information about a subscription for this requestor. Upon success, the response contains entity body with the subscription for the requestor.",
"operationId": "ApplicationsSubscription_GET",
"tags": [
"appSubscriptions"
],
"responses": {
"200": {
"$ref": "#/components/responses/ApplicationsSubscription.200"
},
"400": {
"$ref": "#/components/responses/Error.400"
},
"403": {
"$ref": "#/components/responses/Error.403"
},
"404": {
"$ref": "#/components/responses/Error.404"
}
}
},
"delete": {
"description": "This method deletes a meMp1Subscription. This method is typically used in \"Unsubscribing from service availability event notifications\" procedure.",
"operationId": "ApplicationsSubscription_DELETE",
"tags": [
"appSubscriptions"
],
"responses": {
"204": {
"description": "No Content"
},
"403": {
"$ref": "#/components/responses/Error.403"
},
"404": {
"$ref": "#/components/responses/Error.404"
}
"$ref": "#/components/requestBodies/ApplicationsTrafficRule"
}
}
},
"/applications/{appInstanceId}/traffic_rules": {
"/applications/{appInstanceId}/dns_rules": {
"parameters": [
{
"$ref": "#/components/parameters/Path.AppInstanceId"
}
],
"get": {
"description": "This method retrieves information about all the traffic rules associated with a mobile edge application instance.",
"operationId": "ApplicationsTrafficRules_GET",
"description": "This method retrieves information about all the DNS rules associated with a MEC application instance.",
"operationId": "ApplicationsDnsRules_GET",
"tags": [
"appTrafficRules"
"appDnsRules"
],
"responses": {
"200": {
"$ref": "#/components/responses/ApplicationsTrafficRules.200"
"$ref": "#/components/responses/ApplicationsDnsRules.200"
},
"400": {
"$ref": "#/components/responses/Error.400"
......@@ -311,24 +159,24 @@
}
}
},
"/applications/{appInstanceId}/traffic_rules/{trafficRuleId}": {
"/applications/{appInstanceId}/dns_rules/{dnsRuleId}": {
"parameters": [
{
"$ref": "#/components/parameters/Path.AppInstanceId"
},
{
"$ref": "#/components/parameters/Path.TrafficRuleId"
"$ref": "#/components/parameters/Path.DnsRuleId"
}
],
"get": {
"description": "This method retrieves information about all the traffic rules associated with a mobile edge application instance.",
"operationId": "ApplicationsTrafficRule_GET",
"description": "This method retrieves information about a DNS rule associated with a MEC application instance.",
"operationId": "ApplicationsDnsRule_GET",
"tags": [
"appTrafficRules"
"appDnsRules"
],
"responses": {
"200": {
"$ref": "#/components/responses/ApplicationsTrafficRule.200"
"$ref": "#/components/responses/ApplicationsDnsRule.200"
},
"400": {
"$ref": "#/components/responses/Error.400"
......@@ -342,14 +190,14 @@
}
},
"put": {
"description": "This method retrieves information about all the traffic rules associated with a mobile edge application instance.",
"operationId": "ApplicationsTrafficRule_PUT",
"description": "This method activates, de-activates or updates a traffic rule.",
"operationId": "ApplicationsDnsRule_PUT",
"tags": [
"appTrafficRules"
"appDnsRules"
],
"responses": {
"200": {
"$ref": "#/components/responses/ApplicationsTrafficRule.200"
"$ref": "#/components/responses/ApplicationsDnsRule.200"
},
"400": {
"$ref": "#/components/responses/Error.400"
......@@ -365,45 +213,25 @@
}
},
"requestBody": {
"$ref": "#/components/requestBodies/ApplicationsTrafficRule"
"$ref": "#/components/requestBodies/ApplicationsDnsRule"
}
}
},
"/applications/{appInstanceId}/services": {
"/applications/{appInstanceId}/subscriptions": {
"parameters": [
{
"$ref": "#/components/parameters/Path.AppInstanceId"
}
],
"get": {
"description": "This method retrieves information about a list of meService resources. This method is typically used in \"service availability query\" procedure",
"operationId": "AppServices_GET",
"description": "The GET method may be used to request information about all subscriptions for this requestor. Upon success, the response contains entity body with all the subscriptions for the requestor.",
"operationId": "ApplicationsSubscriptions_GET",
"tags": [
"appServices"
],
"parameters": [
{
"$ref": "#/components/parameters/Query.Ser_instance_id"
},
{
"$ref": "#/components/parameters/Query.Ser_name"
},
{
"$ref": "#/components/parameters/Query.Ser_category_id"
},
{
"$ref": "#/components/parameters/Query.Consumed_local_only"
},
{
"$ref": "#/components/parameters/Query.Is_local"
},
{
"$ref": "#/components/parameters/Query.LocalityTypes"
}
"appSubscriptions"
],
"responses": {
"200": {
"$ref": "#/components/responses/Services.200"
"$ref": "#/components/responses/ApplicationsSubscriptions.200"
},
"400": {
"$ref": "#/components/responses/Error.400"
......@@ -417,14 +245,14 @@
}
},
"post": {
"description": "This method is used to create a meService resource. This method is typically used in \"service availability update and new service registration\" procedure",
"operationId": "AppServices_POST",
"description": "The POST method may be used to create a new subscription. One example use case is to create a new subscription to the MEC service availability notifications. Upon success, the response contains entity body describing the created subscription.",
"operationId": "ApplicationsSubscriptions_POST",
"tags": [
"appServices"
"appSubscriptions"
],
"responses": {
"201": {
"$ref": "#/components/responses/Services.201"
"$ref": "#/components/responses/ApplicationsSubscriptions.201"
},
"400": {
"$ref": "#/components/responses/Error.400"
......@@ -437,28 +265,33 @@
}
},
"requestBody": {
"$ref": "#/components/requestBodies/Services.Post"
"$ref": "#/components/requestBodies/ApplicationsSubscriptions"
},
"callbacks": {
"appTerminationNotification": {
"$ref": "#/components/callbacks/AppTerminationNotification"
}
}
}
},
"/applications/{appInstanceId}/services/{serviceId}": {
"/applications/{appInstanceId}/subscriptions/{subscriptionId}": {
"parameters": [
{
"$ref": "#/components/parameters/Path.AppInstanceId"
},
{
"$ref": "#/components/parameters/Path.ServiceId"
"$ref": "#/components/parameters/Path.SubscriptionId"
}
],
"get": {
"description": "This method retrieves information about a meService resource. This method is typically used in \"service availability query\" procedure",
"operationId": "AppServicesServiceId_GET",
"description": "The GET method requests information about a subscription for this requestor. Upon success, the response contains entity body with the subscription for the requestor.",
"operationId": "ApplicationsSubscription_GET",
"tags": [
"appServices"
"appSubscriptions"
],
"responses": {
"200": {
"$ref": "#/components/responses/ServicesServiceId.200"
"$ref": "#/components/responses/ApplicationsSubscription.200"
},
"400": {
"$ref": "#/components/responses/Error.400"
......@@ -471,67 +304,15 @@
}
}
},
"put": {
"description": "This method updates the information about a meService resource",
"operationId": "AppServicesServiceId_PUT",
"tags": [
"appServices"
],
"responses": {
"200": {
"$ref": "#/components/responses/ServicesServiceId.200"
},
"400": {
"$ref": "#/components/responses/Error.400"
},
"403": {
"$ref": "#/components/responses/Error.403"
},
"404": {
"$ref": "#/components/responses/Error.404"
},
"412": {
"$ref": "#/components/responses/Error.412"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/ServicesServiceId"
}
}
},
"/services": {
"get": {
"description": "This method retrieves information about a list of meService resources. This method is typically used in \"service availability query\" procedure",
"operationId": "Services_GET",
"delete": {
"description": "This method deletes a mecAppSuptApiSubscription. This method is typically used in \"Unsubscribing from service availability event notifications\" procedure.",
"operationId": "ApplicationsSubscription_DELETE",
"tags": [
"services"
],
"parameters": [
{
"$ref": "#/components/parameters/Query.Ser_instance_id"
},
{
"$ref": "#/components/parameters/Query.Ser_name"
},
{
"$ref": "#/components/parameters/Query.Ser_category_id"
},
{
"$ref": "#/components/parameters/Query.Consumed_local_only"
},
{
"$ref": "#/components/parameters/Query.Is_local"
},
{
"$ref": "#/components/parameters/Query.LocalityTypes"
}
"appSubscriptions"
],
"responses": {
"200": {
"$ref": "#/components/responses/Services.200"
},
"400": {
"$ref": "#/components/responses/Error.400"
"204": {
"description": "No Content"
},
"403": {
"$ref": "#/components/responses/Error.403"
......@@ -542,53 +323,36 @@
}
}
},
"/services/{serviceId}": {
"/applications/{appInstanceId}/confirm_termination": {
"parameters": [
{
"$ref": "#/components/parameters/Path.ServiceId"
"$ref": "#/components/parameters/Path.AppInstanceId"
}
],
"get": {
"description": "This method retrieves information about a meService resource. This method is typically used in \"service availability query\" procedure",
"operationId": "ServicesServiceId_GET",
"tags": [
"services"
],
"responses": {
"200": {
"$ref": "#/components/responses/ServicesServiceId.200"
},
"400": {
"$ref": "#/components/responses/Error.400"
},
"403": {
"$ref": "#/components/responses/Error.403"
},
"404": {
"$ref": "#/components/responses/Error.404"
}
}
}
},
"/timing/current_time": {
"get": {
"description": "This method retrieves the information of the platform's current time which corresponds to the get platform time procedure",
"operationId": "TimingCurrentTime_GET",
"post": {
"description": "This method is used to confirm the application level termination of an application instance.",
"operationId": "ApplicationsConfirmTermination_POST",
"tags": [
"timing"
"appConfirmTermination"
],
"responses": {
"200": {
"$ref": "#/components/responses/TimingCurrentTime.200"
"204": {
"description": "No Content"
},
"400": {
"$ref": "#/components/responses/Error.400"
"401": {
"$ref": "#/components/responses/Error.401"
},
"403": {
"$ref": "#/components/responses/Error.403"
},
"404": {
"$ref": "#/components/responses/Error.404"
},
"409": {
"$ref": "#/components/responses/Error.409"
},
"429": {
"$ref": "#/components/responses/Error.429"
}
}
}
......@@ -616,16 +380,16 @@
}
}
},
"/transports": {
"/timing/current_time": {
"get": {
"description": "This method retrieves information about a list of available transports. This method is typically used by a service-producing application to discover transports provided by the mobile edge platform in the \"transport information query\" procedure",
"operationId": "Transports_GET",
"description": "This method retrieves the information of the platform's current time which corresponds to the get platform time procedure",
"operationId": "TimingCurrentTime_GET",
"tags": [
"transports"
"timing"
],
"responses": {
"200": {
"$ref": "#/components/responses/Transports.200"
"$ref": "#/components/responses/TimingCurrentTime.200"
},
"400": {
"$ref": "#/components/responses/Error.400"
......@@ -646,7 +410,7 @@
"description": "Empty schema"
},
"AppTerminationNotification.Links": {
"description": "List of hyperlinks related to the resource.",