MEC010-2_AppPkgMgmt.json 79.3 KB
Newer Older
Elian Kraja's avatar
Elian Kraja committed
          "type": "object",
          "x-etsi-ref": "6.2.1.10"
        },
        "TrafficRuleDescriptor": {
          "properties": {
            "action": {
              "$ref": "#/components/schemas/Action"
            },
            "dstInterface": {
              "type": "array",
              "minItems": 0,
              "maxItems": 2,
              "items": {
                "$ref": "#/components/schemas/InterfaceDescriptor"
              }
            },
            "filterType": {
              "$ref": "#/components/schemas/FilterType"
            },
            "priority": {
              "description": "Priority of this traffic rule. If traffic rule conflicts, the one with higher priority take precedence.",
              "type": "integer",
              "x-etsi-mec-cardinality": "1",
              "x-etsi-mec-origin-type": "Int"
            },
            "trafficFilter": {
              "description": "The filter used to identify specific flow/packets that need to be handled by the MEC host.",
              "items": {
                "$ref": "#/components/schemas/TrafficFilter"
              },
              "minItems": 1,
              "type": "array",
              "x-etsi-mec-cardinality": "1..N",
              "x-etsi-mec-origin-type": "TrafficFilter"
            },
            "trafficRuleId": {
              "description": "Identifies the traffic rule.",
              "type": "string",
              "x-etsi-mec-cardinality": "1",
              "x-etsi-mec-origin-type": "String"
            }
Elian Kraja's avatar
Elian Kraja committed
          "required": [
            "trafficRuleId",
            "filterType",
            "priority",
            "trafficFilter",
            "action"
          ],
          "type": "object",
          "x-etsi-ref": "6.2.1.9"
Elian Kraja's avatar
Elian Kraja committed
        "Action": {
          "description": "'Identifies the action of the MEC host data plane, when a packet matches the trafficFilter.'",
          "type": "string",
          "enum": [
            "DROP",
            "FORWARD_DECAPSULATED",
            "FORWARD_AS_IS",
            "PASSTHROUGH",
            "DUPLICATED_DECAPSULATED",
            "DUPLICATE_AS_IS"
          ]
        },
        "FilterType": {
          "description": "Definition of filter type: per FLOW or PACKET",
          "type": "string",
          "enum": [
            "FLOW",
            "PACKET"
          ]
        },
        "TransportDependency": {
          "properties": {
            "labels": {
              "description": "Set of labels that allow to define groups of transport bindings. The mechanism of the grouping is defined below this table.",
              "items": {
                "type": "string"
              },
              "minItems": 1,
              "type": "array",
              "x-etsi-mec-cardinality": "1..N",
              "x-etsi-mec-origin-type": "String"
            },
            "serializers": {
              "description": "Information about the serializers in this transport binding, as defined in the SerializerTypes type in ETSI GS MEC 011 [i.4]. Support for at least one of the entries is required in conjunction with the transport.",
              "items": {
                "$ref": "#/components/schemas/SerializerTypes"
              },
              "minItems": 1,
              "type": "array",
              "x-etsi-mec-cardinality": "1..N",
              "x-etsi-mec-origin-type": "SerializerTypes"
            },
            "transport": {
              "$ref": "#/components/schemas/TransportDescriptor"
            }
Elian Kraja's avatar
Elian Kraja committed
          "required": [
            "transport",
            "serializers",
            "labels"
          ],
          "type": "object",
          "x-etsi-ref": "6.2.1.18"
        },
        "TransportDescriptor": {
          "properties": {
            "protocol": {
              "description": "The name of the protocol used. Shall be set to HTTP for a REST API.",
              "type": "string",
              "x-etsi-mec-cardinality": "1",
              "x-etsi-mec-origin-type": "String"
            },
            "security": {
              "$ref": "#/components/schemas/SecurityInfo"
            },
            "type": {
              "$ref": "#/components/schemas/TransportTypes"
            },
            "version": {
              "description": "The version of the protocol used.",
              "type": "string",
              "x-etsi-mec-cardinality": "1",
              "x-etsi-mec-origin-type": "String"
            }
Elian Kraja's avatar
Elian Kraja committed
          "required": [
            "type",
            "protocol",
            "version",
            "security"
          ],
          "type": "object",
          "x-etsi-ref": "6.2.1.19"
        },
        "TransportTypes": {
          "type": "string"
        },
        "TunnelInfo": {
          "properties": {
            "tunnelDstAddress": {
              "description": "Destination address of the tunnel.",
              "type": "string",
              "x-etsi-mec-cardinality": "1",
              "x-etsi-mec-origin-type": "String"
            },
            "tunnelSpecificData": {
              "$ref": "#/components/schemas/Not_specified"
            },
            "tunnelSrcAddress": {
              "description": "Source address of the tunnel.",
              "type": "string",
              "x-etsi-mec-cardinality": "1",
              "x-etsi-mec-origin-type": "String"
            },
            "tunnelType": {
              "$ref": "#/components/schemas/TunnelType"
            }
Elian Kraja's avatar
Elian Kraja committed
          "required": [
            "tunnelType",
            "tunnelDstAddress",
            "tunnelSrcAddress"
          ],
          "type": "object",
          "x-etsi-ref": "6.2.1.12"
Elian Kraja's avatar
Elian Kraja committed
        "TunnelType": {
          "description": "Type of tunnel.",
          "type": "string",
          "enum": [
            "GTP-U",
            "GRE"
          ]
        },
        "VirtualComputeDescription": {
          "description": "Ref NFV",
          "type": "string"
        },
        "VirtualNetworkInterfaceRequirements": {
          "type": "string"
        },
        "VirtualStorageDescriptor": {
          "description": "Ref NFV",
          "type": "string"
        },
        "SecurityInfo": {
          "description": "See MEC011"
        },
        "CategoryRef": {
          "description": "See MEC011"
        },
        "URI": {
          "type": "string"
        },
        "Not_specified": {
          "type": "string"
        }
Elian Kraja's avatar
Elian Kraja committed
      "responses": {
        "204": {
          "description": "No Content"
        },
        "206": {
          "description": "Partial content"
        },
        "400": {
          "description": "Bad Request : used to indicate that incorrect parameters were passed to the request.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProblemDetails"
              }
Elian Kraja's avatar
Elian Kraja committed
        },
        "401": {
          "description": "Unauthorized :  used when the client did not submit credentials.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProblemDetails"
              }
Elian Kraja's avatar
Elian Kraja committed
        },
        "403": {
          "description": "Forbidden :  operation is not allowed given the current status of the resource.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProblemDetails"
              }
Elian Kraja's avatar
Elian Kraja committed
        },
        "404": {
          "description": "Not Found :  used when a client provided a URI that cannot be mapped to a valid resource URI.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProblemDetails"
              }
Elian Kraja's avatar
Elian Kraja committed
        },
        "406": {
          "description": "Not Acceptable : used to indicate that the server cannot provide the any of the content formats supported by the client.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProblemDetails"
              }
Elian Kraja's avatar
Elian Kraja committed
        },
        "409": {
          "description": "Conflict : The operation cannot be executed currently, due to a conflict with the state of the resource",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProblemDetails"
              }
Elian Kraja's avatar
Elian Kraja committed
        },
        "412": {
          "description": "Precondition failed :  used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts when using PUT",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProblemDetails"
              }
Elian Kraja's avatar
Elian Kraja committed
        },
        "414": {
          "description": "URI Too Long : used to indicate that the server is refusing to process the request because the request URI is longer than the server is willing or able to process.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProblemDetails"
              }
Elian Kraja's avatar
Elian Kraja committed
        },
        "415": {
          "description": "Unsupported Media Type :  used to indicate that the server or the client does not support the content type of the entity body.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProblemDetails"
              }
Elian Kraja's avatar
Elian Kraja committed
        },
        "416": {
          "description": "Range Not Satisfiable ."
        },
        "422": {
          "description": "Unprocessable Entity : used to indicate that the server understands the content type of the request entity and that the syntax of the request entity is correct but that the server is unable to process the contained instructions. This error condition can occur if an JSON request body is syntactically correct but semantically incorrect, for example if the target area for the request is considered too large. This error condition can also occur if the capabilities required by the request are not supported.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProblemDetails"
              },
              "example": {
                "application/problem+json": {
                  "problemDetails": {
                    "type": "https://meAppServer.example.com/rni/v2/probs/too-many targets",
                    "title": "Too many targets",
                    "status": "422",
                    "detail": "The target area for the request is considered too large",
                    "instance": "/meAppClient.example.com/77777/msgs/abc"
                  }
Elian Kraja's avatar
Elian Kraja committed
        },
        "429": {
          "description": "Too Many Requests : used when a rate limiter has triggered.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ProblemDetails"
              }
Elian Kraja's avatar
Elian Kraja committed
        },
        "AppPkgContent.200": {
          "description": "The payload body shall contain a copy of the file representing the AppD or a ZIP file that contains the file or multiple files representing the AppD."