MecAppSupportApi.json

      "EndPointInfo.Address": {
        "title": "EndPointInfo.Address",
        "required": [
          "host",
          "port"
        ],
        "type": "object",
        "properties": {
          "host": {
            "type": "string",
            "description": "Host portion of the address",
            "examples": [
              "192.0.2.0"
            ]
          },
          "port": {
            "type": "integer",
            "description": "Port portion of the address",
            "contentEncoding": "int32",
            "examples": [
              8080
            ]
          }
        },
        "description": "A IP address and port pair"
      },
      "EndPointInfo.Addresses": {
        "title": "EndPointInfo.Addresses",
        "required": [
          "addresses"
        ],
        "type": "object",
        "properties": {
          "addresses": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/EndPointInfo.Address"
            },
            "description": "Entry point information of the service as one or more pairs of IP address and port. See note."
          }
        },
        "description": "This type represents information about a transport endpoint."
      },
      "EndPointInfo.Alternative": {
        "title": "EndPointInfo.Alternative",
        "required": [
          "alternative"
        ],
        "type": "object",
        "properties": {
          "alternative": {
            "type": "object",
            "description": "Entry point information of the service in a format defined by an implementation, or in an external specification. See note."
          }
        },
        "description": "This type represents information about a transport endpoint."
      },
      "EndPointInfo.Uris": {
        "title": "EndPointInfo.Uris",
        "required": [
          "uris"
        ],
        "type": "object",
        "properties": {
          "uris": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Entry point information of the service as string, formatted according to URI syntax"
          }
        },
        "description": "This type represents information about a transport endpoint."
      },
      "EndPointInfo.Fqdn": {
        "title": "EndPointInfo.Fqdn",
        "required": [
          "fqdn"
        ],
        "type": "object",
        "properties": {
          "fqdn": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Fully Qualified Domain Name of the service. See note."
          }
        },
        "description": "This type represents information about a transport endpoint. "
      },
      "ServiceDependency": {
        "properties": {
          "requestedPermissions": {
            "description": "Requested permissions regarding the access of the application to the service. See clause 8.2 of ETSI GS MEC 009 [4].\nThe format of this attribute is left for the data model design stage.",
            "items": {
              "$ref": "#/components/schemas/Not_specified"
            },
            "minItems": 0,
            "type": "array"
          },
          "serCategory": {
            "$ref": "#/components/schemas/CategoryRef"
          },
          "serName": {
            "description": "The name of the service, for example, RNIS, LocationService, etc.",
            "type": "string"
          },
          "serTransportDependencies": {
            "description": "Indicates transport and serialization format dependencies of consuming the service. Defaults to REST + JSON if absent. See note.",
            "items": {
              "$ref": "#/components/schemas/TransportDependency"
            },
            "minItems": 0,
            "type": "array"
          },
          "version": {
            "description": "The version of the service.",
            "type": "string"
          }
        },
        "required": [
          "serName",
          "version"
        ],
        "type": "object",
        "x-etsi-notes": "NOTE:\tThis attribute indicates groups of transport bindings that a service-consuming MEC application supports for the consumption of the MEC service defined by this ServiceDependency structure. If at least one of the indicated groups is supported by the service it may be consumed by the application."
      },
      "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"
          },
          "serializers": {
            "description": "Information about the serializers in this transport binding, as defined in the SerializerType 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/SerializerType"
            },
            "minItems": 1,
            "type": "array"
          },
          "transport": {
            "$ref": "#/components/schemas/TransportDescriptor"
          }
        },
        "required": [
          "transport",
          "serializers",
          "labels"
        ],
        "type": "object"
      },
      "TransportDescriptor": {
        "properties": {
          "protocol": {
            "description": "The name of the protocol used. Shall be set to \"HTTP\" for a REST API.",
            "type": "string"
          },
          "security": {
            "$ref": "#/components/schemas/SecurityInfo"
          },
          "type": {
            "$ref": "#/components/schemas/TransportType"
          },
          "version": {
            "description": "The version of the protocol used.",
            "type": "string"
          }
        },
        "required": [
          "type",
          "protocol",
          "version",
          "security"
        ],
        "type": "object"
      },
      "SerializerType": {
        "title": "SerializerType",
        "enum": [
          "JSON",
          "XML",
          "PROTOBUF3"
        ],
        "type": "string",
        "description": "The enumeration represents types of serializers",
        "examples": [
          "JSON"
        ]
      },
      "SecurityInfo": {
        "title": "SecurityInfo",
        "type": "object",
        "properties": {
          "oAuth2Info": {
            "$ref": "#/components/schemas/SecurityInfo.OAuth2Info"
          }
        },
        "description": "This type represents security information related to a transport"
      },
      "SecurityInfo.OAuth2Info": {
        "title": "SecurityInfo.OAuth2Info",
        "required": [
          "grantTypes",
          "tokenEndpoint"
        ],
        "type": "object",
        "properties": {
          "grantTypes": {
            "maxItems": 4,
            "minItems": 1,
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SecurityInfo.OAuth2Info.GrantType"
            },
            "description": "List of supported OAuth 2.0 grant types."
          },
          "tokenEndpoint": {
            "type": "string",
            "description": "The token endpoint",
            "examples": [
              "/mecSerMgmtApi/security/TokenEndPoint"
            ]
          }
        },
        "description": "Parameters related to use of OAuth 2.0"
      },
      "SecurityInfo.OAuth2Info.GrantType": {
        "title": "SecurityInfo.OAuth2Info.GrantType",
        "enum": [
          "OAUTH2_AUTHORIZATION_CODE",
          "OAUTH2_IMPLICIT_GRANT",
          "OAUTH2_RESOURCE_OWNER",
          "OAUTH2_CLIENT_CREDENTIALS"
        ],
        "type": "string",
        "description": "OAuth 2.0 grant type",
        "examples": [
          "OAUTH2_CLIENT_CREDENTIALS"
        ]
      },
      "TransportType": {
        "title": "TransportType",
        "enum": [
          "REST_HTTP",
          "MB_TOPIC_BASED",
          "MB_ROUTING",
          "MB_PUBSUB",
          "RPC",
          "RPC_STREAMING",
          "WEBSOCKET"
        ],
        "type": "string",
        "description": "The enumeration TransportType represents types of transports",
        "examples": [
          "REST_HTTP"
        ]
      },
      "FeatureDependency": {
        "properties": {
          "featureName": {
            "description": "The name of the feature, for example, UserApps, UEIdentity, etc.",
            "type": "string"
          },
          "version": {
            "description": "The version of the feature.",
            "type": "string"
          }
        },
        "required": [
          "featureName",
          "version"
        ],
        "type": "object"
      },
      "AppProfile": {
        "type": "object",
        "required": [
          "easId",
          "endPt",
          "acIds",
          "scheds",
          "permLvl",
          "easFeats",
          "svcContSupp",
          "appLocs"
        ],
        "properties": {
          "easId": {
            "description": "The identifier of the EAS",
            "type": "string",
            "examples": [
              "appName"
            ]
          },
          "endPt": {
            "description": "The version of the feature.",
            "oneOf": [
              {
                "$ref": "#/components/schemas/EndPointInfo.Uris"
              },
              {
                "$ref": "#/components/schemas/EndPointInfo.Fqdn"
              },
              {
                "$ref": "#/components/schemas/EndPointInfo.Addresses"
              },
              {
                "$ref": "#/components/schemas/EndPointInfo.Alternative"
              }
            ]
          },
          "acIds": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "minItems": 1,
            "description": "Identities of the Application Clients that can be served by the EAS"
          },
          "provId": {
            "type": "string",
            "description": "Identifier of the ASP that provides the EAS.",
            "examples": [
              "appProvider1"
            ]
          },
          "type": {
            "description": "The category or type of EAS.",
            "type": "string"
          },
          "scheds": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "minItems": 1,
            "description": "The availability schedule of the EAS."
          },
          "svcArea": {
            "type": "string",
            "description": "The list of geographical and topological areas that the EAS serves. ACs in the UE that are outside the area will not be served."
          },
          "svcKpi": {
            "type": "string",
            "description": "Service characteristics provided by the EAS."
          },
          "permLvl": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "minItems": 1,
            "description": "level of service permissions supported by the EAS."
          },
          "easFeats": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "minItems": 1,
            "description": "Service features supported by the EAS."
          },
          "svcContSupp": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "minItems": 1,
            "description": "The ACR scenarios supported by the EAS for service continuity."
          },
          "appLocs": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "minItems": 1,
            "description": "List of DNAI(s) and the N6 traffic information associated with the EAS."
          },
          "avlRep": {
            "type": "integer",
            "description": "The period indicating to the EES, how often the EES needs to check the EAS's availability after a successful registration.",
            "contentEncoding": "int32",
            "examples": [
              1577836800
            ]
          },
          "status": {
            "type": "string",
            "description": "EAS status information. "
          }
        }
      }
    },
    "requestBodies": {
      "AppTerminationNotification": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/AppTerminationNotification"
            }
          }
        },
        "required": true
      }
    }
  },
  "security": [
    {}
  ]
}