UEAppInterfaceApi.json 45.1 KB
Newer Older
Michel Roy's avatar
Michel Roy committed
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/LocationConstraints"
                    },
                    {
                      "description": "It shall match one of the appLocations in the AppContext sent in the Application context create "
                    },
                    {
                      "x-etsi-mec-cardinality": "1"
                    },
                    {
                      "x-etsi-mec-origin-type": "LocationConstraints"
                    }
                  ]
                }
              }
            },
            "minItems": 1,
            "required": [
              "appLocation"
            ],
            "type": "array",
            "x-etsi-mec-cardinality": "1..N",
            "x-etsi-mec-origin-type": "array (Structure (inline))"
Michel Roy's avatar
Michel Roy committed
          "contextId": {
            "description": "Uniquely identifies the application context in the MEC system.",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
Michel Roy's avatar
Michel Roy committed
          "notificationType": {
            "description": "Shall be set to \"ApplicationLocationAvailabilityNotification\".",
            "type": "string",
            "x-etsi-mec-cardinality": "1",
            "x-etsi-mec-origin-type": "String"
        "type": "object",
        "required": [
Michel Roy's avatar
Michel Roy committed
          "notificationType",
          "availableLocations"
Michel Roy's avatar
Michel Roy committed
        "x-etsi-ref": "6.4.5"
      },
      "LocationConstraints": {
        "properties": {
Michel Roy's avatar
Michel Roy committed
          "area": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Polygon"
              },
              {
                "description": "Geographic area. Shall be absent if the \"civicAddressElement\" attribute is present. The content of this attribute shall follow the provisions for the \"Polygon\" geometry object as defined in IETF RFC 7946 [8], for which the \"type\" member shall be set to the value \"Polygon\". See note."
              },
              {
                "x-etsi-mec-cardinality": "0..1"
              },
              {
                "x-etsi-mec-origin-type": "Polygon"
              }
            ]
Michel Roy's avatar
Michel Roy committed
          "civicAddressElement": {
            "description": "Zero or more elements comprising the civic address. Shall be absent if the \"area\" attribute is present.",
            "items": {
              "type": "object",
              "properties": {
                "caType": {
                  "description": "Describe the content type of caValue. The value of caType shall comply with section 3.4 of IETF RFC 4776 [6]. ",
                  "type": "integer",
                  "x-etsi-mec-cardinality": "1",
                  "x-etsi-mec-origin-type": "Integer"
                },
                "caValue": {
                  "description": "Content of civic address element corresponding to the caType. The format caValue shall comply with section 3.4 of IETF RFC 4776 [6].",
                  "type": "string",
                  "x-etsi-mec-cardinality": "1",
                  "x-etsi-mec-origin-type": "String"
                }
              }
            },
            "minItems": 0,
            "required": [
              "caType",
              "caValue"
            ],
            "type": "array",
            "x-etsi-mec-cardinality": "0..N",
            "x-etsi-mec-origin-type": "array (Structure inlined)"
Michel Roy's avatar
Michel Roy committed
          "countryCode": {
            "description": "The two-letter ISO 3166 [7] country code in capital letters. Shall be present in case the \"area\" attribute is absent. May be absent if the \"area\" attribute is present (see note).",
            "type": "string",
            "maxLength": 2,
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
        "type": "object",
Michel Roy's avatar
Michel Roy committed
        "x-etsi-notes": "NOTE:\tIf both \"countryCode\" and \"area\" are present, no conflicts should exist between the values of these two attributes. In case of conflicts, the API producer (e.g. MEO, MEAO) shall disregard parts of the geographic area signalled by \"area\" that are outside the boundaries of the country signalled by \"countryCode\". If \"countryCode\" is absent, it is solely the \"area\" attribute that defines the location constraint.",
        "x-etsi-ref": "6.5.2"
      },
      "Polygon": {
        "properties": {
          "coordinates": {
            "items": {
              "items": {
                "items": {
                  "type": "number",
                  "format": "float"
                },
                "type": "array"
              },
              "type": "array"
            },
            "minItems": 1,
            "type": "array",
            "x-etsi-mec-cardinality": 1,
            "x-etsi-mec-origin-type": "array"
          }
        },
        "type": "object"
      },
      "ProblemDetails": {
        "properties": {
Michel Roy's avatar
Michel Roy committed
          "detail": {
            "description": "A human-readable explanation specific to this occurrence of the problem",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
Michel Roy's avatar
Michel Roy committed
          "instance": {
            "description": "A URI reference that identifies the specific occurrence of the problem",
            "format": "uri",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "URI"
Michel Roy's avatar
Michel Roy committed
          "status": {
            "description": "The HTTP status code for this occurrence of the problem",
            "format": "uint32",
            "type": "integer",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "Uint32"
Michel Roy's avatar
Michel Roy committed
          "title": {
            "description": "A short, human-readable summary of the problem type",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "String"
Michel Roy's avatar
Michel Roy committed
          "type": {
            "description": "A URI reference according to IETF RFC 3986 that identifies the problem type",
            "format": "uri",
            "type": "string",
            "x-etsi-mec-cardinality": "0..1",
            "x-etsi-mec-origin-type": "URI"
Michel Roy's avatar
Michel Roy committed
        },
        "type": "object"