Skip to content
Mp1.json 57.8 KiB
Newer Older
{
  "swagger": "2.0",
  "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"
  },
  "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.Request"
      }
    },
    "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"
      }
    },
    "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.Request"
      }
    },
    "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"
      }
    },
    "Body.TrafficRule": {
      "name": "TrafficRule",
      "description": "One or more updated attributes that are allowed to be changed",
      "in": "body",
      "required": true,
      "schema": {
        "$ref": "#/definitions/TrafficRule"
      }
    },
    "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"
    },
    "Path.DnsRuleId": {
      "name": "dnsRuleId",
      "description": "Represents a DNS rule.",
      "in": "path",
      "required": true,
      "type": "string",
      "format": "uri"
    },
    "Path.SubscriptionId": {
      "name": "subscriptionId",
      "description": "Represents a subscription to the notifications from the mobile edge platform.",
      "in": "path",
      "required": true,
      "type": "string",
      "format": "uri"
    },
    "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"
    },
    "Path.ServiceId": {
      "name": "serviceId",
      "description": "Represents a mobile edge service instance.",
      "in": "path",
      "required": true,
      "type": "string",
      "format": "uri"
    },
    "Path.TrafficRuleId": {
      "name": "trafficRuleId",
      "description": "Represents a traffic rule.",
      "in": "path",
      "required": true,
      "type": "string",
      "format": "uri"
    },
    "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"
    },
    "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"
      }
    },
    "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"
      }
    }
  },
  "paths": {
    "/applications/{appInstanceId}/dns_rules": {
      "parameters": [
        {
          "$ref": "#/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"
        ],
        "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"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/applications/{appInstanceId}/dns_rules/{dnsRuleId}": {
      "parameters": [
        {
          "$ref": "#/parameters/Path.AppInstanceId"
        },
        {
          "$ref": "#/parameters/Path.DnsRuleId"
        }
      ],
      "get": {
        "description": "This method retrieves information about a DNS rule associated with a mobile edge application instance.",
        "operationId": "ApplicationsDnsRule.GET",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
            "schema": {
              "type": "object",
Loading full blame...