Skip to content
MecAppSupportApi.json 80.2 KiB
Newer Older
  "openapi": "3.1.0",
Walter Featherstone's avatar
Walter Featherstone committed
    "title": "MEC Application Support API",
Walter Featherstone's avatar
Walter Featherstone committed
    "description": "The ETSI MEC ISG MEC011 MEC Application Support API described using OpenAPI",
    "license": {
      "name": "BSD-3-Clause",
      "url": "https://forge.etsi.org/legal-matters"
    },
    "contact": {
      "email": "cti_support@etsi.org"
    }
  },
  "externalDocs": {
    "description": "ETSI GS MEC011 Application Enablement API, V2.2.1",
    "url": "https://www.etsi.org/deliver/etsi_gs/MEC/001_099/011/02.02.01_60/gs_MEC011v020201p.pdf"
Walter Featherstone's avatar
Walter Featherstone committed
      "name": "appTrafficRules"
Walter Featherstone's avatar
Walter Featherstone committed
      "name": "appDnsRules"
Walter Featherstone's avatar
Walter Featherstone committed
      "name": "appSubscriptions"
Walter Featherstone's avatar
Walter Featherstone committed
      "name": "appConfirmTermination"
Walter Featherstone's avatar
Walter Featherstone committed
      "name": "appConfirmReady"
Walter Featherstone's avatar
Walter Featherstone committed
      "name": "timing"
    {
      "name": "callbacks"
  "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
  "servers": [
    {
      "url": "http://127.0.0.1:8081/mec_app_support/v1",
      "variables": {}
    },
    {
      "url": "https://127.0.0.1:8081/mec_app_support/v1",
      "variables": {}
    }
  ],
Walter Featherstone's avatar
Walter Featherstone committed
    "/applications/{appInstanceId}/traffic_rules": {
Walter Featherstone's avatar
Walter Featherstone committed
          "appTrafficRules"
        "description": "This method retrieves information about all the traffic rules associated with a MEC application instance.",
        "operationId": "ApplicationsTrafficRules_GET",
        "parameters": [
          {
            "name": "appInstanceId",
            "in": "path",
            "description": "Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
            "headers": {},
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/TrafficRule"
                  },
                  "description": "",
                  "examples": [
                    [
                      {
                        "trafficRuleId": "TrafficRule123",
                        "serName": "ExampleService",
                        "filterType": "FLOW",
                        "priority": 1,
                        "trafficFilter": [
                          {
                            "srcAddress": [
                              "192.168.2.0/24",
                              "192.168.3.0/24"
                            ],
                            "dstAddress": [
                              "192.127.4.100/32"
                            ],
                            "dstPort": [
                              "80"
                            ]
                          }
                        ],
                        "action": "FORWARD_DECAPSULATED",
piscione's avatar
piscione committed
                        "dstInterface": [
                          {
                            "dstInterface0": null,
                            "interfaceType": "IP",
                            "dstIpAddress": "20.1.1.1"
                          },
                          {
                            "dstInterface1": null,
                            "interfaceType": "IP",
                            "dstIpAddress": "20.1.1.2"
                          }
                        ],
                        "state": "ACTIVE"
                      }
                    ]
                  ],
                  "contentMediaType": "application/json"
                },
                "examples": {
                  "TrafficRules": {
                    "value": [
                      {
                        "trafficRuleId": "TrafficRule123",
                        "serName": "ExampleService",
                        "filterType": "FLOW",
                        "priority": 1,
                        "trafficFilter": [
                          {
                            "srcAddress": [
                              "192.168.2.0/24",
                              "192.168.3.0/24"
                            ],
                            "dstAddress": [
                              "192.127.4.100/32"
                            ],
                            "dstPort": [
                              "80"
                            ]
                          }
                        ],
                        "action": "FORWARD_DECAPSULATED",
piscione's avatar
piscione committed
                        "dstInterface": [
                          {
                            "dstInterface0": null,
                            "interfaceType": "IP",
                            "dstIpAddress": "20.1.1.1"
                          }
                        ],
            "description": "Bad Request. It is used to indicate that incorrect parameters were passed to the request.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
            "description": "Forbidden. The operation is not allowed given the current status of the resource.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
            "description": "Not Found. It is used when a client provided a URI that cannot be mapped  to a valid resource URI.",
            "headers": {},
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
Loading full blame...