Mp1.json 78.7 KB
Newer Older
  "info": {
    "title": "Mp1 API",
    "version": "1.1.1",
    "description": "The ETSI MEC ISG MEC011 Application Enablement API described using OpenAPI",
    "license": {
      "name": "ETSI Forge copyright notice",
      "url": "https://forge.etsi.org/etsi-forge-copyright-notice.txt"
    }
  },
  "externalDocs": {
    "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"
  },
  "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"
          }
        }
      }
    },
    "/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"
          }
        }
      },
      "put": {
        "description": "This method activates, de-activates or updates a traffic rule.",
        "operationId": "ApplicationsDnsRule_PUT",
        "responses": {
          "200": {
            "$ref": "#/components/responses/ApplicationsDnsRule.200"
        },
        "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",
        "responses": {
          "200": {
            "$ref": "#/components/responses/ApplicationsSubscriptions.200"
          }
        }
      },
      "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"
            "$ref": "#/components/responses/Error.404"
          }
        },
        "requestBody": {
          "$ref": "#/components/requestBodies/ApplicationsSubscriptions"
        },
        "callbacks": {
          "appTerminationNotification": {
            "$ref": "#/components/callbacks/AppTerminationNotification"
          },
          "serviceAvailabilityNotification": {
            "$ref": "#/components/callbacks/ServiceAvailabilityNotification"
          }
        }
      }
    },
    "/applications/{appInstanceId}/subscriptions/{subscriptionType}/{subscriptionId}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Path.AppInstanceId"
          "$ref": "#/components/parameters/Path.SubscriptionType"
          "$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",
        "responses": {
          "200": {
            "$ref": "#/components/responses/ApplicationsSubscription.200"
          }
        }
      },
      "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": {
          }
        }
      }
    },
    "/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"
          }
        }
      }
    },
    "/applications/{appInstanceId}/traffic_rules/{trafficRuleId}": {
      "parameters": [
        {
          "$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": {
            "$ref": "#/components/responses/ApplicationsTrafficRule.200"
          }
        }
      },
      "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"
        },
        "requestBody": {
          "$ref": "#/components/requestBodies/ApplicationsTrafficRule"
        }
      }
    },
    "/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": "#/components/parameters/Query.Ser_instance_id"
            "$ref": "#/components/parameters/Query.Ser_name"
            "$ref": "#/components/parameters/Query.Ser_category_id"
          }
        ],
        "responses": {
          "200": {
            "$ref": "#/components/responses/Services.200"
          }
        }
      },
      "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": "Services_POST",
        "responses": {
          "201": {
            "$ref": "#/components/responses/Services.201"
          "$ref": "#/components/requestBodies/Services.Post"
        }
      }
    },
    "/services/{serviceId}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/Path.ServiceId"
        }
      ],
      "get": {
        "description": "This method retrieves information about a meService resource. This method is typically used in \"service availability query\" procedure",
        "operationId": "ServicesServiceId_GET",
        "responses": {
          "200": {
            "$ref": "#/components/responses/ServicesServiceId.200"
          }
        }
      },
      "put": {
        "description": "This method updates the information about a meService resource",
        "operationId": "ServicesServiceId_PUT",
        "responses": {
          "200": {
            "$ref": "#/components/responses/ServicesServiceId.200"
        },
        "requestBody": {
          "$ref": "#/components/requestBodies/ServicesServiceId"
        }
      }
    },
    "/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",
        "responses": {
          "200": {
            "$ref": "#/components/responses/TimingCurrentTime.200"
          }
        }
      }
    },
    "/timing/timing_caps": {
      "get": {
        "description": "This method retrieves the information of the platform's timing capabilities which corresponds to the timing capabilities query",
        "operationId": "TimingCaps_GET",
        "responses": {
          "200": {
            "$ref": "#/components/responses/TimingCaps.200"
          }
        }
      }
    },
    "/transports": {
      "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",
        "responses": {
          "200": {
            "$ref": "#/components/responses/Transports.200"
  "components": {
    "schemas": {
      "Empty": {
        "description": "Empty schema"
      },
      "AppTerminationNotification.MaxGracefulTimeout": {
        "description": "Maximum timeout value in seconds for graceful termination or graceful stop of an application instance.",
        "format": "uint32",
        "example": 10
      },
      "AppTerminationNotification.NotificationType": {
        "description": "Shall be set to AppTerminationNotification.",
        "type": "string",
        "example": "AppTerminationNotification"
      },
      "AppTerminationNotification": {
        "description": "This type represents the information that the mobile edge platform notifies the subscribed application instance about  the corresponding application instance termination/stop.",
        "type": "object",
        "required": [
          "notificationType",
          "maxGracefulTimeout",
          "_links"
        ],
        "properties": {
          "notificationType": {
            "$ref": "#/components/schemas/AppTerminationNotification.NotificationType"
          },
          "maxGracefulTimeout": {
            "$ref": "#/components/schemas/AppTerminationNotification.MaxGracefulTimeout"
          },
          "_links": {
            "$ref": "#/components/schemas/Subscription"
          }
      },
      "AppTerminationNotificationSubscription.AppInstanceId": {
        "description": "It is used as the filtering criterion for the subscribed events.",
        "type": "string",
        "example": "ID1"
      },
      "AppTerminationNotificationSubscription.CallbackReference": {
        "description": "URI selected by the mobile edge application instance to receive notifications on the subscribed mobile edge application instance management information. This shall be included in both the request and the response.",
        "type": "string",
        "format": "uri"
      },
      "AppTerminationNotificationSubscription": {
        "description": "This type represents the information that the mobile edge platform notifies the subscribed application instance about  the corresponding application instance termination/stop.",
        "type": "object",
        "required": [
          "subscriptionType",
          "callbackReference",
          "_links",
          "appInstanceId"
        ],
        "properties": {
          "subscriptionType": {
            "$ref": "#/components/schemas/AppTerminationNotificationSubscription.SubscriptionType"
          },
          "callbackReference": {
            "$ref": "#/components/schemas/AppTerminationNotificationSubscription.CallbackReference"
          },
          "_links": {
            "$ref": "#/components/schemas/Self"
          },
          "appInstanceId": {
            "$ref": "#/components/schemas/AppTerminationNotificationSubscription.AppInstanceId"
          }
      },
      "AppTerminationNotificationSubscription.SubscriptionType": {
        "description": "Shall be set to AppTerminationNotificationSubscription.",
        "type": "string",
        "example": "AppTerminationNotificationSubscription"
      },
      "CategoryRef.Href": {
        "description": "Reference of the catalogue",
        "type": "string",
        "example": "catItem1"
      },
      "CategoryRef.Id": {
        "description": "Unique identifier of the category",
        "type": "string",
        "example": "id12345"
      },
      "CategoryRef.Name": {
        "description": "Name of the category",
        "type": "string",
        "example": "RNI"
      },
      "CategoryRef.Version": {
        "description": "Category version",
        "type": "string",
        "example": "version1"
      },
      "CategoryRef": {
        "description": "This type represents the category reference",
        "type": "object",
        "required": [
          "href",
          "id",
          "name",
          "version"
        ],
        "properties": {
          "href": {
            "$ref": "#/components/schemas/CategoryRef.Href"
          },
          "id": {
            "$ref": "#/components/schemas/CategoryRef.Id"
          },
          "name": {
            "$ref": "#/components/schemas/CategoryRef.Name"
          },
          "version": {
            "$ref": "#/components/schemas/CategoryRef.Version"
          }
      },
      "CurrentTime": {
        "description": "This type represents the information provided by the mobile edge platform in response to the Get Platform Time Request message.",
        "type": "object",
        "required": [
          "nanoSeconds",
          "seconds",
          "timeSourceStatus"
        ],
        "properties": {
          "seconds": {
            "type": "integer",
            "format": "uint32",
            "description": "The seconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC",
            "example": 1577836800
          },
          "nanoSeconds": {
            "type": "integer",
            "format": "uint32",
            "description": "The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC",
            "example": 0
          },
          "timeSourceStatus": {
            "type": "string",
            "enum": [
              "TRACEABLE",
              "NONTRACEABLE"
            ],
            "description": "Platform Time Source status. 1 = TRACEABLE - time source is locked to the UTC time source. 2 = NONTRACEABLE - time source is not locked to the UTC time source",
            "example": "TRACEABLE"
          }
      },
      "DestinationInterface.InterfaceType": {
        "description": "Type of the interface",
        "type": "string",
        "enum": [
          "TUNNEL",
          "MAC",
          "IP"
        ],
        "example": "TUNNEL"
      },
      "DestinationInterface.IpAddress": {
        "description": "IP address of the remote destination",
        "type": "string",
        "example": "192.0.2.0"
      },
      "DestinationInterface.MacAddress": {
        "description": "Source address identifies the MAC address of the interface",
        "type": "string",
        "example": "02-00-00-00-00-00"
      },
      "DestinationInterface": {
        "description": "This type represents the destination interface.",
        "type": "object",
        "required": [
          "interfaceType"
        ],
        "properties": {
          "interfaceType": {
            "$ref": "#/components/schemas/DestinationInterface.InterfaceType"
          },
          "tunnelInfo": {
            "$ref": "#/components/schemas/TunnelInfo"
          },
          "srcMacAddress": {
            "$ref": "#/components/schemas/DestinationInterface.MacAddress"
          },
          "dstMacAddress": {
            "$ref": "#/components/schemas/DestinationInterface.MacAddress"
          },
          "dstIpAddress": {
            "$ref": "#/components/schemas/DestinationInterface.IpAddress"
          }
      },
      "DnsRule.DomainName": {
        "description": "FQDN resolved by the DNS rule",
        "type": "string",
        "example": "www.example.com"
      },
      "DnsRule.Id": {
        "description": "Identifies the DNS Rule",
        "type": "string",
        "example": "dnsRule1"
      },
      "DnsRule.IpAddress": {
        "description": "IP address associated with the FQDN resolved by the DNS rule",
        "type": "string",
        "example": "192.0.2.0"
      },
      "DnsRule.IpAddressType": {
        "description": "IP address type",
        "type": "string",
        "enum": [
          "IP_V6",
          "IP_V4"
        ],
        "example": "IP_V6"
      },
      "DnsRule.State": {
        "description": "DNS rule state",
        "type": "string",
        "enum": [
          "ACTIVE",
          "INACTIVE"
        ],
        "example": "ACTIVE"
      },
      "DnsRule.Ttl": {
        "description": "Time to live value",
        "type": "integer",
        "format": "uint32",
        "example": "?"
      },
      "DnsRule": {
        "description": "This type represents the general information of a DNS rule.",
        "type": "object",
        "required": [
          "dnsRuleId",
          "domainName",
          "ipAddressType",
          "ipAddress",
          "state"
        ],
        "properties": {
          "dnsRuleId": {
            "$ref": "#/components/schemas/DnsRule.Id"
          },
          "domainName": {
            "$ref": "#/components/schemas/DnsRule.DomainName"
          },
          "ipAddressType": {
            "$ref": "#/components/schemas/DnsRule.IpAddressType"
          },
          "ipAddress": {
            "$ref": "#/components/schemas/DnsRule.IpAddress"
          },
          "ttl": {
            "$ref": "#/components/schemas/DnsRule.Ttl"
          },
          "state": {
            "$ref": "#/components/schemas/DnsRule.State"
          }
      },
      "EndPointInfo.Address.Host": {
        "description": "Host portion of the address",
        "type": "string",
        "example": "192.0.2.0"
      },
      "EndPointInfo.Address_Port": {
        "description": "Port portion of the address",
        "type": "integer",
        "format": "uint32",
      },
      "EndPointInfo.Address": {
        "description": "A IP address and port pair",
        "type": "object",
        "properties": {
          "host": {
            "$ref": "#/components/schemas/EndPointInfo.Address.Host"
          },
          "port": {
            "$ref": "#/components/schemas/EndPointInfo.Address_Port"
      },
      "EndPointInfo.Addresses": {
        "description": "Entry point information of the service as one or more pairs of IP address and port",
        "type": "object",
        "required": [
          "addresses"
        ],
        "properties": {
          "addresses": {
            "type": "array",
            "minItems": 0,
            "items": {
              "$ref": "#/components/schemas/EndPointInfo.Address"
            }
          }
        }
      },
      "EndPointInfo.Alternative": {
        "description": "Entry point information of the service in a format defined by an implementation, or in an external specification.",
        "type": "object",
        "required": [
          "alternative"
        ],
        "properties": {
          "alternative": {
            "type": "object"
          }
        }
      },
      "EndPointInfo.Uri": {
        "description": "Entry point information of the service",
        "type": "string",
        "format": "uri",
        "example": "/meMp1/service/EntryPoint"
      },
      "EndPointInfo.Uris": {
        "description": "Entry point information of the service as string, formatted according to URI syntax",
        "type": "object",
        "required": [
          "uris"
        ],
        "properties": {
          "uris": {
            "type": "array",
            "minItems": 0,
            "items": {
              "$ref": "#/components/schemas/EndPointInfo.Uri"
            }
          }
        }
      },
      "LinkType": {
        "description": "This type represents a type of link and may be referenced from data structures",
        "type": "object",
        "properties": {
          "href": {
            "$ref": "#/components/schemas/Href"
          }
        }
      },
      "Href": {
        "description": "URI referring to a resource",
        "type": "string",
        "format": "uri",
        "example": "/meMp1/example"
      },
      "Mp1SubscriptionLinkList.Links": {
        "description": "Self-referring URI.",
        "type": "object",
        "required": [
          "self"
        ],
        "properties": {
          "self": {
            "$ref": "#/components/schemas/LinkType"
          },
          "subscription": {
            "description": "Subscription list",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Mp1SubscriptionLinkList.Subscription"
            }
          }
        }
      },
      "Mp1SubscriptionLinkList.Subscription": {
        "description": "A link to a subscription.",
        "type": "object",
        "required": [
          "href",
          "rel"
        ],
        "properties": {
          "href": {
            "$ref": "#/components/schemas/Href"
          },
          "rel": {
            "description": "The values are as defined in the \"subscriptionType\" attribute for each different Mp1 event subscription data type.",
            "type": "string",
            "enum": [
              "AppTerminationNotificationSubscription",
              "SerAvailabilityNotificationSubscription"
            ]
          }
        }
      },
      "Mp1SubscriptionLinkList": {
        "description": "This type represents a list of links related to currently existing subscriptions for a mobile edge application instance. This information is returned when sending a request to receive current subscriptions.",
        "type": "object",
        "required": [
          "_links"
        ],
        "properties": {
          "_links": {
            "$ref": "#/components/schemas/Mp1SubscriptionLinkList.Links"
          }
        }
      },
      "ProblemDetails": {
        "type": "object",
        "properties": {
          "type": {
            "$ref": "#/components/schemas/Problem.type"
          },
          "title": {
            "$ref": "#/components/schemas/Problem.title"
          },
          "status": {
            "$ref": "#/components/schemas/Problem.status"
          },
          "detail": {
            "$ref": "#/components/schemas/Problem.detail"
          },
          "instance": {
            "$ref": "#/components/schemas/Problem.instance"
          }
        }
      },
      "Problem.detail": {
        "type": "string",
        "description": "A human-readable explanation specific to this occurrence of the problem"
      },
      "Problem.instance": {
        "type": "string",
        "format": "uri",
        "description": "A URI reference that identifies the specific occurrence of the problem"
      },
      "Problem.status": {
        "type": "integer",
        "format": "uint32",
        "description": "The HTTP status code for this occurrence of the problem"
      },
      "Problem.title": {
        "type": "string",
        "description": "A short, human-readable summary of the problem type"
      },
      "Problem.type": {
        "type": "string",
        "format": "uri",
        "description": "A URI reference according to IETF RFC 3986 that identifies the problem type"
      },
      "SecurityInfo.OAuth2Info.GrantTypes": {
        "description": "List of supported OAuth 2.0 grant types",
        "type": "string",
        "enum": [
          "OAUTH2_AUTHORIZATION_CODE",
          "OAUTH2_IMPLICIT_GRANT",
          "OAUTH2_RESOURCE_OWNER",
          "OAUTH2_CLIENT_CREDENTIALS"
        ],
        "example": "OAUTH2_CLIENT_CREDENTIALS"
      },
      "SecurityInfo.OAuth2Info.TokenEndpoint": {
        "description": "The token endpoint",
        "type": "string",
        "format": "uri",
        "example": "/meMp1/security/TokenEndPoint"
      },
      "SecurityInfo.OAuth2Info": {
        "description": "Parameters related to use of OAuth 2.0",
        "required": [
          "grantTypes",
          "tokenEndpoint"
        ],
        "properties": {
          "grantTypes": {
            "$ref": "#/components/schemas/SecurityInfo.OAuth2Info.GrantTypes"
          },
          "tokenEndpoint": {
            "$ref": "#/components/schemas/SecurityInfo.OAuth2Info.TokenEndpoint"
          }
        "type": "object"
      },
      "SecurityInfo": {
        "description": "This type represents security information related to a transport",
        "type": "object",
        "properties": {
          "oAuth2Info": {
            "$ref": "#/components/schemas/SecurityInfo.OAuth2Info"
          }
      },
      "Self": {
        "description": "Self-referring URI.",
        "type": "object",
        "required": [
          "self"
        ],
        "properties": {
          "self": {
            "$ref": "#/components/schemas/LinkType"
          }
        "readOnly": true
      },
      "SerAvailabilityNotificationSubscription.CallbackReference": {
        "description": "URI selected by the mobile edge application instance to receive notifications on the subscribed mobile edge service availability information. This shall be included in both the request and the response.",
        "type": "string",
        "format": "uri"
      },
      "SerAvailabilityNotificationSubscription": {
        "description": "This type represents a subscription to the notifications from the mobile edge platform regarding the availability of a mobile edge service or a list of mobile edge services.",
        "type": "object",
        "required": [
          "subscriptionType",
          "callbackReference",
          "_links",
          "filteringCriteria"
        ],
        "properties": {
          "subscriptionType": {
            "$ref": "#/components/schemas/SerAvailabilityNotificationSubscription.SubscriptionType"
          },
          "callbackReference": {
            "$ref": "#/components/schemas/SerAvailabilityNotificationSubscription.CallbackReference"
          },
          "_links": {
            "$ref": "#/components/schemas/Self"
          },
          "filteringCriteria": {
            "$ref": "#/components/schemas/ServiceInfo"
          }
        }
      },
      "SerAvailabilityNotificationSubscription.SubscriptionType": {
        "description": "Shall be set to SerAvailabilityNotificationSubscription.",
        "type": "string",
        "example": "SerAvailabilityNotificationSubscription"
      },
      "ServiceAvailabilityNotification": {
        "description": "This type represents the service availability information.",
        "type": "object",
        "required": [
          "notificationType",
          "services",
          "_links"
        ],
        "properties": {
          "notificationType": {
            "$ref": "#/components/schemas/SerAvailabilityNotificationSubscription.SubscriptionType"
          },
          "services": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ServiceInfo"
            }
          },
          "_links": {