MecAppSupportApi.yaml 91.2 KB
Newer Older
          Message content in the request contains the operational action the
          application instance is responding to.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppTerminationConfirmation'
        required: false
      responses:
Walter Featherstone's avatar
Walter Featherstone committed
        '204':
          description: >-
            No Content. The request is acknowledged. The response message
            content shall be empty.
          headers: {}
          content: {}
Walter Featherstone's avatar
Walter Featherstone committed
        '401':
          description: >-
            Unauthorized. It is used when the client did not submit the
            appropriate credentials.
          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'
            text/plain:
              schema:
                type: object
                description: Empty schema
                contentMediaType: text/plain
Walter Featherstone's avatar
Walter Featherstone committed
        '409':
          description: >-
            Conflict. The operation cannot be executed currently, due to a
            conflict with  the state of the resource. Typically, this is because
            the application  instance resource is in NOT_INSTANTIATED state.
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/plain:
              schema:
                type: object
                description: Empty schema
                contentMediaType: text/plain
Walter Featherstone's avatar
Walter Featherstone committed
        '429':
          description: Too Many Requests. It is used when a rate limiter has triggered.
          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}/confirm_ready':
Walter Featherstone's avatar
Walter Featherstone committed
    post:
        - appConfirmReady
      summary: Confirm ready
      description: >-
        This method may be used by the MEC application instance to notify the
        MEC platform that it is up and running. 
      operationId: ApplicationsConfirmReady_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
          schema:
            type: string
      requestBody:
        description: >-
          Message content in the request contains the indication that the
          application instance is up and running.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppReadyConfirmation'
        required: false
      responses:
Walter Featherstone's avatar
Walter Featherstone committed
        '204':
          description: No Content
          headers: {}
          content: {}
Walter Featherstone's avatar
Walter Featherstone committed
        '401':
          description: >-
            Unauthorized. It is used when the client did not submit the
            appropriate credentials.
          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'
            text/plain:
              schema:
                type: object
                description: Empty schema
                contentMediaType: text/plain
Walter Featherstone's avatar
Walter Featherstone committed
        '409':
          description: >-
            Conflict. The operation cannot be executed currently, due to a
            conflict with  the state of the resource. Typically, this is because
            the application  instance resource is in NOT_INSTANTIATED state.
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/plain:
              schema:
                type: object
                description: Empty schema
                contentMediaType: text/plain
Walter Featherstone's avatar
Walter Featherstone committed
        '429':
          description: Too Many Requests. It is used when a rate limiter has triggered.
          headers: {}
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/plain:
              schema:
                type: object
                description: Empty schema
                contentMediaType: text/plain
      deprecated: false
    parameters: []
1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499
  /registrations:
    post:
      tags:
        - appRegistrations
      summary: Create Registrantion
      description: >-
        The POST method may be used by the MEC application instance to request
        its registration to the MEC platform. 
      operationId: ApplicationsRegistrations_POST
      parameters: [] 
      requestBody:
        description: >-
          The message content in the request contains the profile of the MEC
          application instance, calling the MEC platform to register the MEC
          application instance.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppInfo'
        required: false
      responses:
        '201':
          description: >-
            Indicates successful resource creation for registration of the MEC
            application instance to the MEC platform.
          headers:
            location:
              description: The resource URI of the created resource
              content:
                text/plain:
                  schema:
                    type: string
                    description: The resource URI of the created resource
                    contentMediaType: text/plain
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppInfo'
        '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
        '401':
          description: >-
            Unauthorized. It is used when the client did not submit the
            appropriate credentials.
          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: []
  '/registrations/{appInstanceId}':
    get:
      tags:
        - appRegistrations
      summary: Get Registration
      description: >-
        The GET method may be used by the MEC application instance to retrieve
        information about the existing MEC application instance registration to
        the MEC platform.
      operationId: ApplicationsRegistration_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 message content containing the requested
            subscription is returned.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppInfo'
        '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:
        - appRegistrations
      summary: Update Registration
      description: >-
        The PUT method may be used by the MEC application instance to update its
        registration to the MEC platform.
      operationId: ApplicationsRegistration_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
      requestBody:
        description: >-
          Message content in the request contains the profile of the
          application, calling the MEC platform to update the existing MEC
          application instance registration.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppInfo'
        required: true
      responses:
        '204':
          description: No Content
          headers: {}
          content: {}
        '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
        '401':
          description: >-
            Unauthorized. It is used when the client did not submit the
            appropriate credentials.
          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
    delete:
      tags:
        - appRegistrations
      summary: delete registration
      description: >-
        The DELETE method is used to cancel the existing MEC application
        instance registration.
      operationId: ApplicationsRegistration_DELETE
      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:
        '204':
          description: No Content
          headers: {}
          content: {}
        '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
        '401':
          description: >-
            Unauthorized. It is used when the client did not submit the
            appropriate credentials.
          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: []
  /timing/timing_caps:
        - timing
      summary: Retrieve timing capabilities
      description: >-
        This method retrieves the information of the platform's timing
        capabilities which corresponds to the timing capabilities query
      operationId: TimingCaps_GET
      parameters: []
      responses:
        '200':
          description: >-
            It is used to indicate nonspecific success. The response message
            content contains a representation of the resource.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TimingCaps'
          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'
            text/plain:
              schema:
                type: object
                description: Empty schema
                contentMediaType: text/plain
      deprecated: false
    parameters: []
  /timing/current_time:
        - timing
      summary: Retrieve current time
      description: >-
        This method retrieves the information of the platform's current time
        which corresponds to the get platform time procedure
      operationId: TimingCurrentTime_GET
      parameters: []
      responses:
        '200':
          description: >-
            It is used to indicate nonspecific success. The response message
            content contains a representation of the resource.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CurrentTime'
          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'
            text/plain:
              schema:
                type: object
                description: Empty schema
                contentMediaType: text/plain
      deprecated: false
    parameters: []
Walter Featherstone's avatar
Walter Featherstone committed
    AppReadyConfirmation:
      title: AppReadyConfirmation
Walter Featherstone's avatar
Walter Featherstone committed
      required:
      type: object
Walter Featherstone's avatar
Walter Featherstone committed
      properties:
        indication:
          const: READY
          type: string
          description: Indication about the MEC application instance.
          examples:
            - READY
      description: >-
        This type represents the information that the MEC application instance
        indicates to the MEC platform that it is up and running.
    AppInfo:
      title: AppInfo
      required:
        - appName
      type: object
      properties:
        appName:
          title: appName
          type: string
          description: >-
            Name of the application. It shall be consistent with the appName in
            the AppD, if an AppD is available.
          examples:
            - appName
        appProvider:
          title: appProvider
          type: string
          description: >-
            Provider of the application. It shall be consistent with the
            appProvider in the AppD, if an AppD is available. See note 1.
          examples:
            - appProvider1
        appCategory:
          $ref: '#/components/schemas/CategoryRef'
        appDId:
          title: appDId
          type: string
          description: >-
            The application descriptor identifier. It is managed by the
            application provider to identify the application descriptor in a
            globally unique way. Shall be present if the application instance is
            instantiated by the MEC Management.
          examples:
            - TODO
        appInstanceId:
          title: appInstanceId
          type: string
          description: >-
            Identifier of the application instance. Shall be present if the
            application instance is instantiated by the MEC Management.
          examples:
            - ID1
        endpoint:
          oneOf:
            - $ref: '#/components/schemas/EndPointInfo.Uris'
            - $ref: '#/components/schemas/EndPointInfo.Fqdn'
            - $ref: '#/components/schemas/EndPointInfo.Addresses'
            - $ref: '#/components/schemas/EndPointInfo.Alternative'
          description: This type represents information about a transport endpoint
          x-etsi-notes: "NOTE 1:\tIf appProfile is present, appProvider shall be consistent with provId provided in EAS profile data type, i.e. the same.\nNOTE 2:\tIf appProfile is present, endpoint shall refer to the same end point as endPt provided in EAS profile data type."
        appServiceRequired:
          title: appServiceRequired
          type: array
          items:
            $ref: '#/components/schemas/ServiceDependency'
          description: >-
            Describes services a MEC application requires to run.
            ServiceDependency is defined in ETSI GS MEC 010-2 [4]. It shall not
            be provided if an AppD is available.
        appServiceOptional:
          title: appServiceOptional
          type: array
          items:
            $ref: '#/components/schemas/ServiceDependency'
          description: >-
            Describes services a MEC application may use if available.
            ServiceDependency is defined in ETSI GS MEC 010-2 [4]. It shall not
            be provided if an AppD is available.
        appFeatureRequired:
          title: appFeatureRequired
          type: array
          items:
            $ref: '#/components/schemas/FeatureDependency'
          description: >-
            Describes features a MEC application requires to run.
            FeatureDependency is defined in ETSI GS MEC 010-2 [4]. It shall not
            be provided if an AppD is available.
        appFeatureOptional:
          title: appFeatureOptional
          type: array
          items:
            $ref: '#/components/schemas/FeatureDependency'
          description: >-
            Describes features a MEC application may use if available.
            FeatureDependency is defined in ETSI GS MEC 010-2 [4]. It shall not
            be provided if an AppD is available.
        isInsByMec:
          type: boolean
          description: >-
            Indicate whether the application instance is instantiated by the MEC
            Management.

            Default to FALSE if absent.
          examples:
            - false
        appProfile:
          $ref: '#/components/schemas/AppProfile'
      description: >-
        This type represents the information provided by the MEC application
        instance as part of the "application registration request" and
        "application registration update" messages.
      x-etsi-notes: "NOTE 1:\tIf appProfile is present, appProvider shall be consistent with provId provided in EAS profile data type, i.e. the same.\nNOTE 2:\tIf appProfile is present, endpoint shall refer to the same end point as endPt provided in EAS profile data type."
Walter Featherstone's avatar
Walter Featherstone committed
    AppTerminationConfirmation:
      title: AppTerminationConfirmation
Walter Featherstone's avatar
Walter Featherstone committed
      required:
        - operationAction
      type: object
Walter Featherstone's avatar
Walter Featherstone committed
      properties:
        operationAction:
          $ref: '#/components/schemas/OperationActionType'
      description: >-
        This type represents the information that the MEC application instance
        provides to the MEC platform when informing it that the application has
        completed its application level related terminate/stop actions, e.g.
        retention of application state in the case of stop.
Walter Featherstone's avatar
Walter Featherstone committed
    AppTerminationNotification.Links:
      title: AppTerminationNotification.Links
Walter Featherstone's avatar
Walter Featherstone committed
      required:
      type: object
Walter Featherstone's avatar
Walter Featherstone committed
      properties:
        subscription:
          $ref: '#/components/schemas/LinkType'
        confirmTermination:
          $ref: '#/components/schemas/LinkType.ConfirmTermination'
      description: Object containing hyperlinks related to the resource.
      title: AppTerminationNotification
        - notificationType
        - operationAction
        - maxGracefulTimeout
        - _links
      type: object
          type: string
          description: Shall be set to AppTerminationNotification.
          examples:
            - AppTerminationNotification
Walter Featherstone's avatar
Walter Featherstone committed
        operationAction:
          $ref: '#/components/schemas/OperationActionType'
          type: integer
          description: >-
            Maximum timeout value in seconds for graceful termination or
            graceful stop of an application instance.
          contentEncoding: int32
          examples:
Walter Featherstone's avatar
Walter Featherstone committed
          $ref: '#/components/schemas/AppTerminationNotification.Links'
      description: >-
        This type represents the information that the MEC platform notifies the
        subscribed application instance about  the corresponding application
        instance termination/stop.
      title: AppTerminationNotificationSubscription
        - subscriptionType
        - callbackReference
        - _links
        - appInstanceId
      type: object
          type: string
          description: Shall be set to AppTerminationNotificationSubscription.
          examples:
            - AppTerminationNotificationSubscription
          type: string
          description: >-
            URI selected by the MEC application instance to receive
            notifications on the subscribed MEC application instance management
            information. This shall be included in both the request and the
            response.
        _links:
          $ref: '#/components/schemas/Self'
        appInstanceId:
          type: string
          description: It is used as the filtering criterion for the subscribed events.
          examples:
            - ID1
      description: >-
        This type represents the information that the MEC platform notifies the
        subscribed application instance about  the corresponding application
        instance termination/stop.
      title: CurrentTime
        - seconds
        - nanoSeconds
        - timeSourceStatus
      type: object
          description: >-
            The seconds part of the time. Time is defined as Unix-time since
            January 1, 1970, 00:00:00 UTC
          contentEncoding: int32
          examples:
          description: >-
            The nanoseconds part of the time. Time is defined as Unix-time since
            January 1, 1970, 00:00:00 UTC
          contentEncoding: int32
          examples:
          $ref: '#/components/schemas/TimeSourceStatus'
      description: >-
        This type represents the information provided by the MEC platform in
        response to the Get Platform Time Request message.
      title: DestinationInterface.InterfaceType
      description: Type of the interface
      examples:
      title: DestinationInterface
      type: object
      properties:
        interfaceType:
          $ref: '#/components/schemas/DestinationInterface.InterfaceType'
        tunnelInfo:
          $ref: '#/components/schemas/TunnelInfo'
        srcMacAddress:
          type: string
          description: Source address identifies the MAC address of the interface
          examples:
            - 02-00-00-00-00-00
          type: string
          description: Source address identifies the MAC address of the interface
          examples:
            - 02-00-00-00-00-00
          type: string
          description: IP address of the remote destination
          examples:
            - 192.0.2.0
      description: >-
        This type represents the destination interface. If the action is
        FORWARD_DECAPSULATED, FORWARD_ENCAPSULATED or PASSTHROUGH one value
        shall be provided. If the action is DUPLICATE_DECAPSULATED or
        DUPLICATE_ENCAPSULATED, two values shall be provided. If the action is
        DROP, no value shall be provided.
      title: DnsRule.IpAddressType
      description: IP address type
      examples:
    DnsRule.State:
      title: DnsRule.State
      type: string
      description: DNS rule state. This attribute may be updated using HTTP PUT method
      examples:
      title: DnsRule
        - dnsRuleId
        - domainName
        - ipAddressType
        - ipAddress
        - state
      type: object
          type: string
          description: Identifies the DNS Rule
          examples:
          type: string
          description: FQDN resolved by the DNS rule
          examples:
            - www.example.com
        ipAddressType:
          $ref: '#/components/schemas/DnsRule.IpAddressType'
        ipAddress:
          type: string
          description: IP address associated with the FQDN resolved by the DNS rule
          examples:
          type: integer
          description: Time to live value
          contentEncoding: int32
      description: This type represents the general information of a DNS rule.
      x-etsi-notes: "NOTE:\tIf no ttl value is provided, the DnsRule shall not expire."
Walter Featherstone's avatar
Walter Featherstone committed
    LinkType:
      title: LinkType
      type: object
      properties:
        href:
          type: string
          description: URI referring to a resource
          examples:
            - /mecAppSuptApi/example
      description: >-
        This type represents a type of link and may be referenced from data
        structures
Walter Featherstone's avatar
Walter Featherstone committed
    LinkType.ConfirmTermination:
      title: LinkType.ConfirmTermination
        href:
          type: string
          description: URI referring to a resource
          examples:
            - /mecAppSuptApi/example
      description: >-
        Link to the task resource where to confirm termination in case the 
        application is ready to be terminated before expiry of the timeout.
Walter Featherstone's avatar
Walter Featherstone committed
    MecAppSuptApiSubscriptionLinkList.Links:
      title: MecAppSuptApiSubscriptionLinkList.Links
      type: object
      properties:
        self:
          $ref: '#/components/schemas/LinkType'
Walter Featherstone's avatar
Walter Featherstone committed
        subscriptions:
Walter Featherstone's avatar
Walter Featherstone committed
            $ref: '#/components/schemas/MecAppSuptApiSubscriptionLinkList.Subscription'
          description: The MEC application instance's subscriptions
      description: Self-referring URI.
Walter Featherstone's avatar
Walter Featherstone committed
    MecAppSuptApiSubscriptionLinkList.Subscription:
      title: MecAppSuptApiSubscriptionLinkList.Subscription
        - href
        - subscriptionType
      type: object
          type: string
          description: URI referring to a resource
          examples:
            - /mecAppSuptApi/example
        subscriptionType:
          description: Type of the subscription. The values are as defined in the "subscriptionType" attribute for each different Mp1 event subscription data type.
      description: A link to a subscription.
Walter Featherstone's avatar
Walter Featherstone committed
    MecAppSuptApiSubscriptionLinkList: