MecAppSupportApi.json

{
  "openapi": "3.1.0",
  "info": {
    "title": "MEC Application Support API",
    "version": "2.2.1",
    "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"
  },
  "tags": [
    {
      "name": "appTrafficRules"
    },
    {
      "name": "appDnsRules"
    },
    {
      "name": "appSubscriptions"
    },
    {
      "name": "appConfirmTermination"
    },
    {
      "name": "appConfirmReady"
    },
    {
      "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": {
      }
    }
  ],
  "paths": {
    "/applications/{appInstanceId}/traffic_rules": {
      "get": {
        "tags": [
          "appTrafficRules"
        ],
        "summary": "get traffic rules",
        "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",
                        "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",
                        "dstInterface": [
                          {
                            "dstInterface0": null,
                            "interfaceType": "IP",
                            "dstIpAddress": "20.1.1.1"
                          }
                        ],
                        "state": "ACTIVE"
                      }
                    ]
                  }
                }
              }
            }
          },
          "400": {
            "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"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden. The operation is not allowed given the current status of the resource.",
            "headers": {
            },
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "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"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
          }
        },
        "deprecated": false
      },
      "parameters": [

      ]
    },
    "/applications/{appInstanceId}/traffic_rules/{trafficRuleId}": {
      "get": {
        "tags": [
          "appTrafficRules"
        ],
        "summary": "Get traffic rule",
        "description": "This method retrieves information about all the traffic rules associated with a MEC application instance.",
        "operationId": "ApplicationsTrafficRule_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"
            }
          },
          {
            "name": "trafficRuleId",
            "in": "path",
            "description": "Represents a traffic rule.",
            "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": {
                  "$ref": "#/components/schemas/TrafficRule"
                },
                "examples": {
                  "TrafficRule": {
                    "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",
                      "dstInterface": [
                        {
                          "dstInterface0": null,
                          "interfaceType": "IP",
                          "dstIpAddress": "20.1.1.1"
                        }
                      ],
                      "state": "ACTIVE"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "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"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden. The operation is not allowed given the current status of the resource.",
            "headers": {
            },
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "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"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
          }
        },
        "deprecated": false
      },
      "put": {
        "tags": [
          "appTrafficRules"
        ],
        "summary": "Update traffic rule",
        "description": "This method retrieves information about all the traffic rules associated with a MEC application instance.",
        "operationId": "ApplicationsTrafficRule_PUT",
        "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"
            }
          },
          {
            "name": "trafficRuleId",
            "in": "path",
            "description": "Represents a traffic rule.",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "One or more updated attributes that are allowed to be changed",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TrafficRule"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
            "headers": {
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TrafficRule"
                },
                "examples": {
                  "TrafficRule": {
                    "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",
                      "dstInterface": [
                        {
                          "dstInterface0": null,
                          "interfaceType": "IP",
                          "dstIpAddress": "20.1.1.1"
                        }
                      ],
                      "state": "ACTIVE"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "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"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden. The operation is not allowed given the current status of the resource.",
            "headers": {
            },
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "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"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
          },
          "412": {
            "description": "Precondition Failed. It is used when a condition has failed during conditional requests,  e.g. when using ETags to avoid write conflicts.",
            "headers": {
            },
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
          }
        },
        "deprecated": false
      },
      "parameters": [

      ]
    },
    "/applications/{appInstanceId}/dns_rules": {
      "get": {
        "tags": [
          "appDnsRules"
        ],
        "summary": "Get DNS rules",
        "description": "This method retrieves information about all the DNS rules associated with a MEC application instance.",
        "operationId": "ApplicationsDnsRules_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/DnsRule"
                  },
                  "description": "",
                  "examples": [
                    [
                      {
                        "dnsRuleId": "DnsRule1",
                        "domainName": "www.example.com",
                        "ipAddressType": "IP_V4",
                        "ipAddress": "146.241.7.3",
                        "ttl": 300,
                        "state": "ACTIVE"
                      },
                      {
                        "dnsRuleId": "DnsRule2",
                        "domainName": "www.example.com",
                        "ipAddressType": "IP_V4",
                        "ipAddress": "146.241.7.4",
                        "ttl": 300,
                        "state": "INACTIVE"
                      }
                    ]
                  ],
                  "contentMediaType": "application/json"
                },
                "examples": {
                  "DnsRules": {
                    "value": [
                      {
                        "dnsRuleId": "DnsRule1",
                        "domainName": "www.example.com",
                        "ipAddressType": "IP_V4",
                        "ipAddress": "146.241.7.3",
                        "ttl": 300,
                        "state": "ACTIVE"
                      },
                      {
                        "dnsRuleId": "DnsRule2",
                        "domainName": "www.example.com",
                        "ipAddressType": "IP_V4",
                        "ipAddress": "146.241.7.4",
                        "ttl": 300,
                        "state": "INACTIVE"
                      }
                    ]
                  }
                }
              }
            }
          },
          "400": {
            "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"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden. The operation is not allowed given the current status of the resource.",
            "headers": {
            },
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "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"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
          }
        },
        "deprecated": false
      },
      "parameters": [

      ]
    },
    "/applications/{appInstanceId}/dns_rules/{dnsRuleId}": {
      "get": {
        "tags": [
          "appDnsRules"
        ],
        "summary": "Get DNS rule",
        "description": "This method retrieves information about a DNS rule associated with a MEC application instance.",
        "operationId": "ApplicationsDnsRule_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"
            }
          },
          {
            "name": "dnsRuleId",
            "in": "path",
            "description": "Represents a DNS rule.",
            "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": {
                  "$ref": "#/components/schemas/DnsRule"
                },
                "examples": {
                  "DnsRule": {
                    "value": {
                      "dnsRuleId": "DnsRule1",
                      "domainName": "www.example.com",
                      "ipAddressType": "IP_V4",
                      "ipAddress": "146.241.7.3",
                      "ttl": 300,
                      "state": "ACTIVE"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "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"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden. The operation is not allowed given the current status of the resource.",
            "headers": {
            },
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "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"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
          }
        },
        "deprecated": false
      },
      "put": {
        "tags": [
          "appDnsRules"
        ],
        "summary": "Update DNS rule",
        "description": "This method activates, de-activates or updates a traffic rule.",
        "operationId": "ApplicationsDnsRule_PUT",
        "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"
            }
          },
          {
            "name": "dnsRuleId",
            "in": "path",
            "description": "Represents a DNS rule.",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "The updated state is included in the entity body of the request.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/DnsRule"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
            "headers": {
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DnsRule"
                },
                "examples": {
                  "DnsRule": {
                    "value": {
                      "dnsRuleId": "DnsRule1",
                      "domainName": "www.example.com",
                      "ipAddressType": "IP_V4",
                      "ipAddress": "146.241.7.3",
                      "ttl": 300,
                      "state": "ACTIVE"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "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"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden. The operation is not allowed given the current status of the resource.",
            "headers": {
            },
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "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"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
          },
          "412": {
            "description": "Precondition Failed. It is used when a condition has failed during conditional requests,  e.g. when using ETags to avoid write conflicts.",
            "headers": {
            },
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
          }
        },
        "deprecated": false
      },
      "parameters": [

      ]
    },
    "/applications/{appInstanceId}/subscriptions": {
      "get": {
        "tags": [
          "appSubscriptions"
        ],
        "summary": "Get subscriptions",
        "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",
        "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": "Upon success, a response body containing the list of links to the requested subscriptions is returned.",
            "headers": {
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MecAppSuptApiSubscriptionLinkList"
                }
              }
            }
          },
          "400": {
            "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"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden. The operation is not allowed given the current status of the resource.",
            "headers": {
            },
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "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"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
          }
        },
        "deprecated": false
      },
      "post": {
        "tags": [
          "appSubscriptions"
        ],
        "summary": "Create subscription",
        "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",
        "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",