Skip to content

GitLab

Commit 1821b5f1 authored by Walter Featherstone's avatar Walter Featherstone
Browse files

Converted Mp1 API description to OpenAPI 3, without the split directory structure

parent 241380e2
Show whitespace changes
Inline Side-by-side
Showing with 3586 additions and 4077 deletions
Mp1.json
View file @ 1821b5f1
{
"swagger": "2.0",
"openapi": "3.0.0",
"servers": [
{
"url": "http://127.0.0.1:8081/exampleAPI/mp1/v1/"
},
{
"url": "https://127.0.0.1:8081/exampleAPI/mp1/v1/"
}
],
"info": {
"title": "Mp1 API",
"version": "1.1.1",
......@@ -13,2628 +21,2326 @@
"description": "ETSI GS MEC011 Application Enablement API, V1.1.1",
"url": "http://www.etsi.org/deliver/etsi_gs/MEC/001_099/011/01.01.01_60/gs_mec011v010101p.pdf"
},
"host": "127.0.0.1:8081",
"basePath": "/exampleAPI/mp1/v1/",
"schemes": [
"http",
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": {
"Body.AppTerminationNotificationSubscription": {
"name": "AppTerminationNotificationSubscription",
"description": "Entity body in the request contains a subscription to the mobile edge application termination notifications that is to be created.",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/AppTerminationNotificationSubscription"
"paths": {
"/applications/{appInstanceId}/dns_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",
"responses": {
"200": {
"$ref": "#/components/responses/ApplicationsDnsRules.200"
},
"Body.DnsRule": {
"name": "DnsRule",
"description": "The updated state is included in the entity body of the request.",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/DnsRule"
}
"400": {
"$ref": "#/components/responses/Error.400"
},
"Body.SerAvailabilityNotificationSubscription": {
"name": "SerAvailabilityNotificationSubscription",
"description": "Entity body in the request contains a subscription to the mobile edge service availability notifications that is to be created.",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/SerAvailabilityNotificationSubscription"
}
"403": {
"$ref": "#/components/responses/Error.403"
},
"Body.ServiceInfo": {
"name": "ServiceInfo",
"description": "New ServiceInfo with updated \"state\" is included as entity body of the request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/ServiceInfo"
"404": {
"$ref": "#/components/responses/Error.404"
}
}
}
},
"Body.TrafficRule": {
"name": "TrafficRule",
"description": "One or more updated attributes that are allowed to be changed",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/TrafficRule"
"/applications/{appInstanceId}/dns_rules/{dnsRuleId}": {
"parameters": [
{
"$ref": "#/components/parameters/Path.AppInstanceId"
},
{
"$ref": "#/components/parameters/Path.DnsRuleId"
}
],
"get": {
"description": "This method retrieves information about a DNS rule associated with a mobile edge application instance.",
"operationId": "ApplicationsDnsRule.GET",
"responses": {
"200": {
"$ref": "#/components/responses/ApplicationsDnsRule.200"
},
"Path.AppInstanceId": {
"name": "appInstanceId",
"description": "Represents a mobile edge application instance. Note that the appInstanceId is allocated by the mobile edge platform manager.",
"in": "path",
"required": true,
"type": "string",
"format": "uri"
"400": {
"$ref": "#/components/responses/Error.400"
},
"Path.DnsRuleId": {
"name": "dnsRuleId",
"description": "Represents a DNS rule.",
"in": "path",
"required": true,
"type": "string",
"format": "uri"
"403": {
"$ref": "#/components/responses/Error.403"
},
"Path.SubscriptionId": {
"name": "subscriptionId",
"description": "Represents a subscription to the notifications from the mobile edge platform.",
"in": "path",
"required": true,
"type": "string",
"format": "uri"
"404": {
"$ref": "#/components/responses/Error.404"
}
}
},
"Path.SubscriptionType": {
"name": "subscriptionType",
"description": "Represents a subscription type to the notifications from the mobile edge platform.",
"in": "path",
"required": true,
"type": "string",
"format": "uri"
"put": {
"description": "This method activates, de-activates or updates a traffic rule.",
"operationId": "ApplicationsDnsRule.PUT",
"responses": {
"200": {
"$ref": "#/components/responses/ApplicationsDnsRule.200"
},
"Path.ServiceId": {
"name": "serviceId",
"description": "Represents a mobile edge service instance.",
"in": "path",
"required": true,
"type": "string",
"format": "uri"
"400": {
"$ref": "#/components/responses/Error.400"
},
"Path.TrafficRuleId": {
"name": "trafficRuleId",
"description": "Represents a traffic rule.",
"in": "path",
"required": true,
"type": "string",
"format": "uri"
"403": {
"$ref": "#/components/responses/Error.403"
},
"Query.Ser_category_id": {
"name": "ser_category_id",
"description": "A mobile edge application instance may use ser_category_id as an input parameter to query the availability of a list of mobile edge service instances in a serCategory. Either \"ser_instance_id\" or \"ser_name\" or \"ser_category_id\" or none of them shall be present.",
"in": "query",
"required": false,
"type": "string"
"404": {
"$ref": "#/components/responses/Error.404"
},
"Query.Ser_instance_id": {
"name": "ser_instance_id",
"description": "A mobile edge application instance may use multiple ser_instance_ids as an input parameter to query the availability of a list of mobile edge service instances. Either \"ser_instance_id\" or \"ser_name\" or \"ser_category_id\" or none of them shall be present.",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
"412": {
"$ref": "#/components/responses/Error.412"
}
},
"Query.Ser_name": {
"name": "ser_name",
"description": "A mobile edge application instance may use multiple ser_names as an input parameter to query the availability of a list of mobile edge service instances. Either \"ser_instance_id\" or \"ser_name\" or \"ser_category_id\" or none of them shall be present.",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
"requestBody": {
"$ref": "#/components/requestBodies/ApplicationsDnsRule"
}
}
},
"paths": {
"/applications/{appInstanceId}/dns_rules": {
"/applications/{appInstanceId}/subscriptions": {
"parameters": [
{
"$ref": "#/parameters/Path.AppInstanceId"
"$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",
"produces": [
"application/json"
],
"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",
"responses": {
"200": {
"description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"DnsRule": {
"$ref": "#/definitions/DnsRule"
}
}
}
"$ref": "#/components/responses/ApplicationsSubscriptions.200"
},
"examples": {
"application/json": [{
"DnsRule": {
"dnsRuleId": "DnsRule1",
"domainName": "www.example.com",
"ipAddressType": "IP_V4",
"ipAddress": "146.241.7.3",
"ttl": 300,
"state": "ACTIVE"
"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",
"responses": {
"201": {
"$ref": "#/components/responses/ApplicationsSubscriptions.201"
},
"400": {
"description": "Bad Request",
"schema": {
"type": "object",
"properties": {
"ProblemDetails": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
"$ref": "#/components/responses/Error.400"
},
"403": {
"description": "Forbidden",
"schema": {
"type": "object",
"required": [
"ProblemDetails"
],
"properties": {
"ProblemDetails": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
"$ref": "#/components/responses/Error.403"
},
"404": {
"description": "Not Found",
"schema": {
"type": "object",
"properties": {
"ProblemDetails": {
"$ref": "#/definitions/ProblemDetails"
}
}
"$ref": "#/components/responses/Error.404"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/ApplicationsSubscriptions"
},
"callbacks": {
"appTerminationNotification": {
"$ref": "#/components/callbacks/AppTerminationNotification"
},
"serviceAvailabilityNotification": {
"$ref": "#/components/callbacks/ServiceAvailabilityNotification"
}
}
}
},
"/applications/{appInstanceId}/dns_rules/{dnsRuleId}": {
"/applications/{appInstanceId}/subscriptions/{subscriptionType}/{subscriptionId}": {
"parameters": [
{
"$ref": "#/parameters/Path.AppInstanceId"
"$ref": "#/components/parameters/Path.AppInstanceId"
},
{
"$ref": "#/components/parameters/Path.SubscriptionType"
},
{
"$ref": "#/parameters/Path.DnsRuleId"
"$ref": "#/components/parameters/Path.SubscriptionId"
}
],
"get": {
"description": "This method retrieves information about a DNS rule associated with a mobile edge application instance.",
"operationId": "ApplicationsDnsRule.GET",
"produces": [
"application/json"
],
"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",
"responses": {
"200": {
"description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
"schema": {
"type": "object",
"properties": {
"DnsRule": {
"$ref": "#/definitions/DnsRule"
"$ref": "#/components/responses/ApplicationsSubscription.200"
},
"400": {
"$ref": "#/components/responses/Error.400"
},
"403": {
"$ref": "#/components/responses/Error.403"
},
"404": {
"$ref": "#/components/responses/Error.404"
}
}
},
"examples": {
"application/json": {
"DnsRule": {
"dnsRuleId": "DnsRule1",
"domainName": "www.example.com",
"ipAddressType": "IP_V4",
"ipAddress": "146.241.7.3",
"ttl": 300,
"state": "ACTIVE"
"delete": {
"description": "This method deletes a meMp1Subscription. This method is typically used in \"Unsubscribing from service availability event notifications\" procedure.",
"operationId": "ApplicationsSubscription.DELETE",
"responses": {
"204": {
"description": "No Content"
},
"403": {
"$ref": "#/components/responses/Error.403"
},
"404": {
"$ref": "#/components/responses/Error.404"
}
}
}
},
"/applications/{appInstanceId}/traffic_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",
"responses": {
"200": {
"$ref": "#/components/responses/ApplicationsTrafficRules.200"
},
"400": {
"description": "Bad Request",
"schema": {
"type": "object",
"properties": {
"ProblemDetails": {
"$ref": "#/definitions/ProblemDetails"
"$ref": "#/components/responses/Error.400"
},
"403": {
"$ref": "#/components/responses/Error.403"
},
"404": {
"$ref": "#/components/responses/Error.404"
}
}
}
},
"403": {
"description": "Forbidden",
"schema": {
"type": "object",
"required": [
"ProblemDetails"
],
"properties": {
"ProblemDetails": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
},
"404": {
"description": "Not Found",
"schema": {
"type": "object",
"properties": {
"ProblemDetails": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
}
}
},
"put": {
"description": "This method activates, de-activates or updates a traffic rule.",
"operationId": "ApplicationsDnsRule.PUT",
"produces": [
"application/json"
],
"/applications/{appInstanceId}/traffic_rules/{trafficRuleId}": {
"parameters": [
{
"$ref": "#/parameters/Body.DnsRule"
"$ref": "#/components/parameters/Path.AppInstanceId"
},
{
"$ref": "#/components/parameters/Path.TrafficRuleId"
}
],
"get": {
"description": "This method retrieves information about all the traffic rules associated with a mobile edge application instance.",
"operationId": "ApplicationsTrafficRule.GET",
"responses": {
"200": {
"description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
"schema": {
"type": "object",
"properties": {
"DnsRule": {
"$ref": "#/definitions/DnsRule"
}
}
"$ref": "#/components/responses/ApplicationsTrafficRule.200"
},
"examples": {
"application/json": {
"DnsRule": {
"dnsRuleId": "DnsRule1",
"domainName": "www.example.com",
"ipAddressType": "IP_V4",
"ipAddress": "146.241.7.3",
"ttl": 300,
"state": "ACTIVE"
}
"400": {
"$ref": "#/components/responses/Error.400"
},
"403": {
"$ref": "#/components/responses/Error.403"
},
"404": {
"$ref": "#/components/responses/Error.404"
}
}
},
"put": {
"description": "This method retrieves information about all the traffic rules associated with a mobile edge application instance.",
"operationId": "ApplicationsTrafficRule.PUT",
"responses": {
"200": {
"$ref": "#/components/responses/ApplicationsTrafficRule.200"
},
"400": {
"description": "Bad Request",
"schema": {
"type": "object",
"properties": {
"ProblemDetails": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
"$ref": "#/components/responses/Error.400"
},
"403": {
"description": "Forbidden",
"schema": {
"type": "object",
"required": [
"ProblemDetails"
],
"properties": {
"ProblemDetails": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
"$ref": "#/components/responses/Error.403"
},
"404": {
"description": "Not Found",
"schema": {
"type": "object",
"properties": {
"ProblemDetails": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
"$ref": "#/components/responses/Error.404"
},
"412": {
"description": "Precondition Failed",
"schema": {
"type": "object",
"properties": {
"ProblemDetails": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
"$ref": "#/components/responses/Error.412"
}
},
"requestBody": {
"$ref": "#/components/requestBodies/ApplicationsTrafficRule"
}
}
},
"/applications/{appInstanceId}/subscriptions": {
"/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",
"parameters": [
{
"$ref": "#/parameters/Path.AppInstanceId"
"$ref": "#/components/parameters/Query.Ser_instance_id"
},
{
"$ref": "#/components/parameters/Query.Ser_name"
},
{
"$ref": "#/components/parameters/Query.Ser_category_id"
}
],
"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",
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Upon success, a response body containing the list of links to the requested subscriptions is returned.",
"schema": {
"type": "object",
"properties": {
"Mp1SubscriptionLinkList": {
"$ref": "#/definitions/Mp1SubscriptionLinkList"
}
}
}
"$ref": "#/components/responses/Services.200"
},
"400": {
"description": "Bad Request",
"schema": {
"type": "object",
"properties": {
"ProblemDetails": {
"$ref": "#/definitions/ProblemDetails"
}
}
}
"$ref": "#/components/responses/Error.400"
},
"403": {
"description": "Forbidden",
"schema": {
"type": "object",
"required": [
"ProblemDetails"
],