Mp1.yaml 44.2 KB
Newer Older
swagger: '2.0'
info:
  version: 1.1.1
  description: The ETSI MEC ISG MEC016 UE Application Interface API described using OpenAPI
  license:
    name: ETSI Forge copyright notice
    url: 'https://forge.etsi.org/etsi-forge-copyright-notice.txt'
externalDocs:
  description: ETSI GS MEC011 Application Enablement API, V1.1.1
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000
  url: 'http://www.etsi.org/deliver/etsi_gs/MEC/001_099/011/01.01.01_60/gs_mec011v010101p.pdf'
host: '127.0.0.1:8081'
basePath: /exampleAPI/mp1/v1/
schemes:
  - http
  - https
consumes:
  - application/json
produces:
  - application/json
parameters:
  Body.AppTerminationNotificationSubscription:
    name: AppTerminationNotificationSubscription
    description: Entity body in the request contains a subscription to the mobile edge application termination notifications that is to be created.
    in: body
    required: true
    schema:
      $ref: '#/definitions/AppTerminationNotificationSubscription.Request'
  Body.DnsRule:
    name: DnsRule
    description: The updated ÔÇ£stateÔÇØ is included in the entity body of the request.
    in: body
    required: true
    schema:
      $ref: '#/definitions/DnsRule'
  Body.SerAvailabilityNotificationSubscription:
    name: SerAvailabilityNotificationSubscription
    description: Entity body in the request contains a subscription to the mobile edge service availability notifications that is to be created.
    in: body
    required: true
    schema:
      $ref: '#/definitions/SerAvailabilityNotificationSubscription.Request'
  Body.ServiceInfo:
    name: ServiceInfo
    description: New ServiceInfo with updated "state" is included as entity body of the request
    in: body
    required: true
    schema:
      $ref: '#/definitions/ServiceInfo'
  Body.TrafficRule:
    name: TrafficRule
    description: One or more updated attributes that are allowed to be changed
    in: body
    required: true
    schema:
      $ref: '#/definitions/TrafficRule'
  Path.AppInstanceId:
    name: appInstanceId
    description: Represents a mobile edge application instance. Note that the appInstanceId is allocated by the mobile edge platform manager.
    in: path
    required: true
    type: string
    format: uri
  Path.DnsRuleId:
    name: dnsRuleId
    description: Represents a DNS rule.
    in: path
    required: true
    type: string
    format: uri
  Path.SubscriptionId:
    name: subscriptionId
    description: Represents a subscription to the notifications from the mobile edge platform.
    in: path
    required: true
    type: string
    format: uri
  Path.SubscriptionType:
    name: subscriptionType
    description: Represents a subscription type to the notifications from the mobile edge platform.
    in: path
    required: true
    type: string
    format: uri
  Path.ServiceId:
    name: serviceId
    description: Represents a mobile edge service instance.
    in: path
    required: true
    type: string
    format: uri
  Path.TrafficRuleId:
    name: trafficRuleId
    description: Represents a traffic rule.
    in: path
    required: true
    type: string
    format: uri
  Query.Ser_category_id:
    name: ser_category_id
    description: A mobile edge application instance may use ser_category_id as an input parameter to query the availability of a list of mobile edge service instances in a serCategory. Either "ser_instance_id" or "ser_name" or "ser_category_id" or none of them shall be present.
    in: query
    required: false
    type: string
  Query.Ser_instance_id:
    name: ser_instance_id
    description: A mobile edge application instance may use multiple ser_instance_ids as an input parameter to query the availability of a list of mobile edge service instances. Either "ser_instance_id" or "ser_name" or "ser_category_id" or none of them shall be present.
    in: query
    required: false
    type: array
    items:
      type: string
  Query.Ser_name:
    name: ser_name
    description: A mobile edge application instance may use multiple ser_names as an input parameter to query the availability of a list of mobile edge service instances. Either "ser_instance_id" or "ser_name" or "ser_category_id" or none of them shall be present.
    in: query
    required: false
    type: array
    items:
      type: string
paths:
  '/applications/{appInstanceId}/dns_rules':
    get:
      description: This method retrieves information about all the DNS rules associated with a mobile edge application instance.
      operationId: ApplicationsDnsRules.GET
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/Path.AppInstanceId'
      responses:
        '200':
          description: It is used to indicate nonspecific success. The response body contains a representation of the resource.
          schema:
            type: array
            items:
              type: object
              properties:
                DnsRule:
                  $ref: '#/definitions/DnsRule'
  '/applications/{appInstanceId}/dns_rules/{dnsRuleId}':
    get:
      description: This method retrieves information about a DNS rule associated with a mobile edge application instance.
      operationId: ApplicationsDnsRule.GET
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/Path.AppInstanceId'
        - $ref: '#/parameters/Path.DnsRuleId'
      responses:
        '200':
          description: It is used to indicate nonspecific success. The response body contains a representation of the resource.
          schema:
            type: object
            properties:
              DnsRule:
                $ref: '#/definitions/DnsRule'
    put:
      description: 'This method activates, de-activates or updates a traffic rule.'
      operationId: ApplicationsDnsRule.PUT
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/Body.DnsRule'
        - $ref: '#/parameters/Path.AppInstanceId'
        - $ref: '#/parameters/Path.DnsRuleId'
      responses:
        '200':
          description: It is used to indicate nonspecific success. The response body contains a representation of the resource.
          schema:
            type: object
            properties:
              DnsRule:
                $ref: '#/definitions/DnsRule'
  '/applications/{appInstanceId}/subscriptions':
    get:
      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
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/Path.AppInstanceId'
      responses:
        '200':
          description: 'Upon success, a response body containing the list of links to the requested subscriptions is returned.'
          schema:
            type: object
            properties:
              Mp1SubscriptionLinkList:
                $ref: '#/definitions/Mp1SubscriptionLinkList'
    post:
      description: 'The POST method may be used to create a new subscription. One example use case is to create a new subscription to the mobile edge service availability notifications. Upon success, the response contains entity body describing the created subscription.'
      operationId: ApplicationsSubscriptions.POST
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/Path.AppInstanceId'
        - $ref: '#/parameters/Body.AppTerminationNotificationSubscription'
      responses:
        '200':
          description: Entity body in the request contains a subscription to the mobile edge service availability notifications that is to be created.
          schema:
            type: object
            properties:
              AppTerminationNotificationSubscription:
                $ref: '#/definitions/AppTerminationNotificationSubscription.Response'
  '/applications/{appInstanceId}/subscriptions/{subscriptionType}/{subscriptionId}':
    get:
      description: 'The GET method requests information about a subscription for this requestor. Upon success, the response contains entity body with the subscription for the requestor.'
      operationId: ApplicationsSubscription.GET
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/Path.AppInstanceId'
        - $ref: '#/parameters/Path.SubscriptionType'
        - $ref: '#/parameters/Path.SubscriptionId'
      responses:
        '200':
          description: 'Upon success, a response body containing the requested subscription is returned.'
          schema:
            type: object
            properties:
              SerAvailabilityNotificationSubscription:
                $ref: '#/definitions/SerAvailabilityNotificationSubscription.Response'
    delete:
      description: This method deletes a meMp1Subscription. This method is typically used in "Unsubscribing from service availability event notifications" procedure.
      operationId: ApplicationsSubscription.DELETE
      produces:
        - application/json
      responses:
        '204':
          description: No Content
  '/applications/{appInstanceId}/traffic_rules':
    get:
      description: This method retrieves information about all the traffic rules associated with a mobile edge application instance.
      operationId: ApplicationsTrafficRules.GET
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/Path.AppInstanceId'
      responses:
        '200':
          description: It is used to indicate nonspecific success. The response body contains a representation of the resource.
          schema:
            type: array
            items:
              type: object
              properties:
                TrafficRule:
                  $ref: '#/definitions/TrafficRule'
  '/applications/{appInstanceId}/traffic_rules/{trafficRuleId}':
    get:
      description: This method retrieves information about all the traffic rules associated with a mobile edge application instance.
      operationId: ApplicationsTrafficRule.GET
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/Path.AppInstanceId'
        - $ref: '#/parameters/Path.TrafficRuleId'
      responses:
        '200':
          description: It is used to indicate nonspecific success. The response body contains a representation of the resource.
          schema:
            type: object
            properties:
              TrafficRule:
                $ref: '#/definitions/TrafficRule'
    put:
      description: This method retrieves information about all the traffic rules associated with a mobile edge application instance.
      operationId: ApplicationsTrafficRules.PUT
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/Body.TrafficRule'
        - $ref: '#/parameters/Path.AppInstanceId'
        - $ref: '#/parameters/Path.TrafficRuleId'
      responses:
        '200':
          description: 'Upon success, a response body containing data type describing the updated TrafficRule is returned.'
          schema:
            type: object
            properties:
              TrafficRule:
                $ref: '#/definitions/TrafficRule'
  /services:
    get:
      description: This method retrieves information about a list of meService resources. This method is typically used in "service availability query" procedure
      operationId: Services.GET
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/Query.Ser_instance_id'
        - $ref: '#/parameters/Query.Ser_name'
        - $ref: '#/parameters/Query.Ser_category_id'
      responses:
        '200':
          description: It is used to indicate nonspecific success. The response body contains a representation of the resource.
          schema:
            type: array
            items:
              type: object
              properties:
                ServiceInfo:
                  $ref: '#/definitions/ServiceInfo'
    put:
      description: This method is used to create a meService resource. This method is typically used in "service availability update and new service registration" procedure
      operationId: Services.POST
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/Body.ServiceInfo'
      responses:
        '201':
          description: 'Upon success, the HTTP response shall include a Location HTTP header that contains the resource URI of the created resource.'
          schema:
            type: object
            properties:
              ServiceInfo:
                $ref: '#/definitions/ServiceInfo'
  '/services/{serviceId}':
    get:
      description: This method retrieves information about a meService resource. This method is typically used in "service availability query" procedure
      operationId: ServicesServiceId.GET
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/Path.ServiceId'
      responses:
        '200':
          description: It is used to indicate nonspecific success. The response body contains a representation of the resource.
          schema:
            type: object
            properties:
              ServiceInfo:
                $ref: '#/definitions/ServiceInfo'
          examples:
            application/json:
              ServiceInfo:
                serInstanceId: ServiceInstance123
                serName: ExampleService
                serCategory:
                  href: catItem1
                  id: id12345
                  name: RNI
                  version: version1
                version: ServiceVersion1
                state: ACTIVE
                transportId: Rest1
                transportInfo:
                  id: TransId12345
                  name: REST
                  description: REST API
                  type: JSON
                  protocol: HTTP
                  version: '2.0'
                  endpoint:
                    uris:
                      - /meMp1/service/EntryPoint
                    addresses:
                      - host: 192.0.2.0
                        port: '8080'
                  mp1.security:
                    oAuth2Info:
                      grantTypes: OAUTH2_CLIENT_CREDENTIALS
                      tokenEndpoint: /meMp1/mp1.security/TokenEndPoint
                serializer: JSON
    put:
      description: This method updates the information about a meService resource
      operationId: ServicesServiceId.PUT
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/Path.ServiceId'
        - $ref: '#/parameters/Body.ServiceInfo'
      responses:
        '200':
          description: 'Upon success, a response body containing data type describing the updated ServiceInfo is returned'
          schema:
            type: object
            properties:
              ServiceInfo:
                $ref: '#/definitions/ServiceInfo'
          examples:
            application/json:
              ServiceInfo:
                serInstanceId: ServiceInstance123
                serName: ExampleService
                serCategory:
                  href: catItem1
                  id: id12345
                  name: RNI
                  version: version1
                version: ServiceVersion1
                state: ACTIVE
                transportId: Rest1
                transportInfo:
                  id: TransId12345
                  name: REST
                  description: REST API
                  type: JSON
                  protocol: HTTP
                  version: '2.0'
                  endpoint:
                    uris:
                      - /meMp1/service/EntryPoint
                    addresses:
                      - host: 192.0.2.0
                        port: '8080'
                  mp1.security:
                    oAuth2Info:
                      grantTypes: OAUTH2_CLIENT_CREDENTIALS
                      tokenEndpoint: /meMp1/mp1.security/TokenEndPoint
                serializer: JSON
  /timing/current_time:
    get:
      description: This method retrieves the information of the platform's current time which corresponds to the get platform time procedure
      operationId: TimingCurrentTime.GET
      produces:
        - application/json
      responses:
        '200':
          description: It is used to indicate nonspecific success. The response body contains a representation of the resource.
          schema:
            type: object
            properties:
              CurrentTime:
                $ref: '#/definitions/CurrentTime'
  /timing/timing_caps:
    get:
      description: This method retrieves the information of the platform's timing capabilities which corresponds to the timing capabilities query
      operationId: TimingCaps.GET
      produces:
        - application/json
      responses:
        '200':
          description: It is used to indicate nonspecific success. The response body contains a representation of the resource.
          schema:
            type: object
            properties:
              TimingCaps:
                $ref: '#/definitions/TimingCaps'
  /transports:
    get:
      description: This method retrieves information about a list of available transports. This method is typically used by a service-producing application to discover transports provided by the mobile edge platform in the "transport information query" procedure
      operationId: Transports.GET
      produces:
        - application/json
      responses:
        '200':
          description: It is used to indicate nonspecific success. The response body contains a representation of the resource.
          schema:
            type: array
            items:
              type: object
              properties:
                TransportInfo:
                  $ref: '#/definitions/TransportInfo'
definitions:
  AppTerminationNotification.MaxGracefulTimeout:
    description: Maximum timeout value in seconds for graceful termination or graceful stop of an application instance.
    type: string
    format: uint32
    example: 10
  AppTerminationNotification.NotificationType:
    description: Shall be set to AppTerminationNotification.
    type: string
    example: AppTerminationNotification
  AppTerminationNotification:
    description: This type represents the information that the mobile edge platform notifies the subscribed application instance about  the corresponding application instance termination/stop.
    type: object
    required:
      - notificationType
      - maxGracefulTimeout
      - _links
    properties:
      notificationType:
        $ref: '#/definitions/AppTerminationNotification.NotificationType'
      maxGracefulTimeout:
        $ref: '#/definitions/AppTerminationNotification.MaxGracefulTimeout'
      _links:
        $ref: '#/definitions/Subscription'
  AppTerminationNotificationSubscription.AppInstanceId:
    description: It is used as the filtering criterion for the subscribed events.
    type: string
    example: ID1
  AppTerminationNotificationSubscription.CallbackReference:
    description: URI selected by the mobile edge application instance to receive notifications on the subscribed mobile edge application instance management information. This shall be included in both the request and the response.
    type: string
    format: uri
  AppTerminationNotificationSubscription.Request:
    description: This type represents the information that the mobile edge platform notifies the subscribed application instance about  the corresponding application instance termination/stop.
    type: object
    required:
      - subscriptionType
      - callbackReference
      - appInstanceId
    properties:
      subscriptionType:
        $ref: '#/definitions/AppTerminationNotificationSubscription.SubscriptionType'
      callbackReference:
        $ref: '#/definitions/AppTerminationNotificationSubscription.CallbackReference'
      appInstanceId:
        $ref: '#/definitions/AppTerminationNotificationSubscription.AppInstanceId'
  AppTerminationNotificationSubscription.Response:
    description: This type represents the information that the mobile edge platform notifies the subscribed application instance about  the corresponding application instance termination/stop.
    type: object
    required:
      - subscriptionType
      - callbackReference
      - _links
      - appInstanceId
    properties:
      subscriptionType:
        $ref: '#/definitions/AppTerminationNotificationSubscription.SubscriptionType'
      callbackReference:
        $ref: '#/definitions/AppTerminationNotificationSubscription.CallbackReference'
      _links:
        $ref: '#/definitions/Self'
      appInstanceId:
        $ref: '#/definitions/AppTerminationNotificationSubscription.AppInstanceId'
  AppTerminationNotificationSubscription.SubscriptionType:
    description: Shall be set to AppTerminationNotificationSubscription.
    type: string
    example: AppTerminationNotificationSubscription
  CategoryRef.Href:
    description: Reference of the catalogue
    type: string
    example: catItem1
  CategoryRef.Id:
    description: Unique identifier of the category
    type: string
    example: id12345
  CategoryRef.Name:
    description: Name of the category
    type: string
    example: RNI
  CategoryRef.Version:
    description: Category version
    type: string
    example: version1
  CategoryRef:
    description: This type represents the category reference
    type: object
    required:
      - href
      - id
      - name
      - version
    properties:
      href:
        $ref: '#/definitions/CategoryRef.Href'
      id:
        $ref: '#/definitions/CategoryRef.Id'
      name:
        $ref: '#/definitions/CategoryRef.Name'
      version:
        $ref: '#/definitions/CategoryRef.Version'
  CurrentTime:
    description: This type represents the information provided by the mobile edge platform in response to the Get Platform Time Request message.
    type: object
    required:
      - nanoSeconds
      - seconds
      - timeSourceStatus
    properties:
      seconds:
        type: integer
        format: uint32
        description: 'The seconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC'
        example: 1577836800
      nanoSeconds:
        type: integer
        format: uint32
        description: 'The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC'
        example: 0
      timeSourceStatus:
        type: string
        enum:
          - TRACEABLE
          - NONTRACEABLE
        description: Platform Time Source status. 1 = TRACEABLE - time source is locked to the UTC time source. 2 = NONTRACEABLE - time source is not locked to the UTC time source
        example: TRACEABLE
  DestinationInterface.InterfaceType:
    description: Type of the interface
    type: string
    enum:
      - TUNNEL
      - MAC
      - IP
    example: TUNNEL
  DestinationInterface.IpAddress:
    description: IP address of the remote destination
    type: string
    example: 192.0.2.0
  DestinationInterface.MacAddress:
    description: Source address identifies the MAC address of the interface
    type: string
    example: 02-00-00-00-00-00
  DestinationInterface:
    description: This type represents the destination interface.
    type: object
    required:
      - interfaceType
    properties:
      interfaceType:
        $ref: '#/definitions/DestinationInterface.InterfaceType'
      tunnelInfo:
        $ref: '#/definitions/TunnelInfo'
      srcMacAddress:
        $ref: '#/definitions/DestinationInterface.MacAddress'
      dstMacAddress:
        $ref: '#/definitions/DestinationInterface.MacAddress'
      dstIpAddress:
        $ref: '#/definitions/DestinationInterface.IpAddress'
  DnsRule.DomainName:
    description: FQDN resolved by the DNS rule
    type: string
    example: www.example.com
  DnsRule.Id:
    description: Identifies the DNS Rule
    type: string
    example: dnsRule1
  DnsRule.IpAddress:
    description: IP address associated with the FQDN resolved by the DNS rule
    type: string
    example: 192.0.2.0
  DnsRule.IpAddressType:
    description: IP address type
    type: string
    enum:
      - IP_V6
      - IP_V4
    example: IP_V6
  DnsRule.State:
    description: DNS rule state
    type: string
    enum:
      - ACTIVE
      - INACTIVE
    example: ACTIVE
  DnsRule.Ttl:
    description: Time to live value
    type: integer
    format: uint32
    example: '?'
  DnsRule:
    description: This type represents the general information of a DNS rule.
    type: object
    required:
      - dnsRuleId
      - domainName
      - ipAddressType
      - ipAddress
      - state
    properties:
      dnsRuleId:
        $ref: '#/definitions/DnsRule.Id'
      domainName:
        $ref: '#/definitions/DnsRule.DomainName'
      ipAddressType:
        $ref: '#/definitions/DnsRule.IpAddressType'
      ipAddress:
        $ref: '#/definitions/DnsRule.IpAddress'
      ttl:
        $ref: '#/definitions/DnsRule.Ttl'
      state:
        $ref: '#/definitions/DnsRule.State'
  EndPointInfo.Address.Host:
    description: Host portion of the address
    type: string
    example: 192.0.2.0
  EndPointInfo.Address.Port:
    description: Port portion of the address
    type: integer
    format: uint32
    example: '8080'
  EndPointInfo.Address:
    description: A IP address and port pair
    type: object
    properties:
      host:
        $ref: '#/definitions/EndPointInfo.Address.Host'
      port:
        $ref: '#/definitions/EndPointInfo.Address.Port'
  EndPointInfo.Addresses:
    description: Entry point information of the service as one or more pairs of IP address and port
    type: array
    items:
      $ref: '#/definitions/EndPointInfo.Address'
  EndPointInfo.Alternative:
    description: 'Entry point information of the service in a format defined by an implementation, or in an external specification.'
    type: object
  EndPointInfo.Uri:
    description: Entry point information of the service
    type: string
    format: uri
    example: /meMp1/service/EntryPoint
  EndPointInfo.Uris:
    description: 'Entry point information of the service as string, formatted according to URI syntax'
    type: array
    items:
      $ref: '#/definitions/EndPointInfo.Uri'
  EndPointInfo:
    description: This type represents information about a transport endpoint
    type: object
    properties:
      uris:
        $ref: '#/definitions/EndPointInfo.Uris'
      addresses:
        $ref: '#/definitions/EndPointInfo.Addresses'
      alternative:
        $ref: '#/definitions/EndPointInfo.Alternative'
  LinkType:
    description: URI referring to a resource
    type: string
    format: uri
    example: /meMp1/example
  Mp1SubscriptionLinkList.Links:
    description: Self-referring URI.
    type: object
    required:
      - self
    properties:
      self:
        $ref: '#/definitions/LinkType'
      subscription:
        description: Subscription list
        type: array
        items:
          $ref: '#/definitions/Mp1SubscriptionLinkList.Subscription'
  Mp1SubscriptionLinkList.Subscription:
    description: A link to a subscription.
    type: object
    required:
      - href
      - rel
    properties:
      href:
        description: The URI referring to the subscription
        type: string
        format: uri
      rel:
        description: The values are as defined in the ÔÇ£subscriptionTypeÔÇØ attribute for each different Mp1 event subscription data type.
        type: string
  Mp1SubscriptionLinkList:
    description: This type represents a list of links related to currently existing subscriptions for a mobile edge application instance. This information is returned when sending a request to receive current subscriptions.
    type: object
    required:
      - _links
    properties:
      _links:
        $ref: '#/definitions/Mp1SubscriptionLinkList.Links'
  SecurityInfo.OAuth2Info.GrantTypes:
    description: List of supported OAuth 2.0 grant types
    type: string
    enum:
      - OAUTH2_AUTHORIZATION_CODE
      - OAUTH2_IMPLICIT_GRANT
      - OAUTH2_RESOURCE_OWNER
      - OAUTH2_CLIENT_CREDENTIALS
    example: OAUTH2_CLIENT_CREDENTIALS
  SecurityInfo.OAuth2Info.TokenEndpoint:
    description: The token endpoint
    type: string
    format: uri
    example: /meMp1/mp1.security/TokenEndPoint
  SecurityInfo.OAuth2Info:
    description: Parameters related to use of OAuth 2.0
    required:
      - grantTypes
      - tokenEndpoint
    properties:
      grantTypes:
        $ref: '#/definitions/SecurityInfo.OAuth2Info.GrantTypes'
      tokenEndpoint:
        $ref: '#/definitions/SecurityInfo.OAuth2Info.TokenEndpoint'
  SecurityInfo:
    description: This type represents security information related to a transport
    type: object
    required:
      - oAuth2Info
    properties:
      oAuth2Info:
        $ref: '#/definitions/SecurityInfo.OAuth2Info'
  Self:
    description: Self-referring URI.
    type: object
    required:
      - self
    properties:
      self:
        $ref: '#/definitions/LinkType'
  SerAvailabilityNotificationSubscription.CallbackReference:
    description: URI selected by the mobile edge application instance to receive notifications on the subscribed mobile edge service availability information. This shall be included in both the request and the response.
    type: string
    format: uri
  SerAvailabilityNotificationSubscription.Request:
    description: This type represents a subscription to the notifications from the mobile edge platform regarding the availability of a mobile edge service or a list of mobile edge services.
    type: object
    required:
      - subscriptionType
      - callbackReference
      - filteringCriteria
    properties:
      subscriptionType:
        $ref: '#/definitions/SerAvailabilityNotificationSubscription.SubscriptionType'
      callbackReference:
        $ref: '#/definitions/SerAvailabilityNotificationSubscription.CallbackReference'
      filteringCriteria:
        $ref: '#/definitions/ServiceInfo'
  SerAvailabilityNotificationSubscription.Response:
    description: This type represents a subscription to the notifications from the mobile edge platform regarding the availability of a mobile edge service or a list of mobile edge services.
    type: object
    required:
      - subscriptionType
      - callbackReference
      - _links
      - filteringCriteria
    properties:
      subscriptionType:
        $ref: '#/definitions/SerAvailabilityNotificationSubscription.SubscriptionType'
      callbackReference:
        $ref: '#/definitions/SerAvailabilityNotificationSubscription.CallbackReference'
      _links:
        $ref: '#/definitions/Self'
      filteringCriteria:
        $ref: '#/definitions/ServiceInfo'
  SerAvailabilityNotificationSubscription.SubscriptionType:
    description: Shall be set to SerAvailabilityNotificationSubscription.
    type: string
    example: SerAvailabilityNotificationSubscription
  SerializerTypes:
    description: The enumeration SerializerTypes represents types of serializers
    type: string
    enum:
      - JSON
      - XML
      - PROTOBUF3
    example: JSON
  ServiceInfo.SerInstanceId:
    description: Identifier of the service instance assigned by the MEPM / mobile edge platform.
    type: string
    example: ServiceInstance123
  ServiceInfo.SerName:
    description: The name of the service. This is how the service producing mobile edge application identifies the service instance it produces.
    type: string
    example: ExampleService
  ServiceInfo.State:
    description: Contains the state
    type: string
    enum:
      - ACTIVE
      - INACTIVE
    example: ACTIVE
  ServiceInfo.TransportId:
    description: 'Identifier of the platform-provided transport to be used by the service. Valid identifiers may be obtained using the ÔÇ£Transport information queryÔÇØ procedure. May be present in POST requests to signal the use of a platform-provided transport for the service, and shall be absent otherwise.'
    type: string
    example: Rest1
  ServiceInfo.Version:
    description: Service version
    type: string
    example: ServiceVersion1
  ServiceInfo:
    description: This type represents the general information of a mobile edge service.
    type: object
    required:
      - serName
      - version
      - state
      - serializer
    properties:
      serInstanceId:
        $ref: '#/definitions/ServiceInfo.SerInstanceId'
      serName:
        $ref: '#/definitions/ServiceInfo.SerName'
      serCategory:
        $ref: '#/definitions/CategoryRef'
      version:
        $ref: '#/definitions/ServiceInfo.Version'
      state:
        $ref: '#/definitions/ServiceInfo.State'
      transportId:
        $ref: '#/definitions/ServiceInfo.TransportId'
      transportInfo:
        $ref: '#/definitions/TransportInfo'
      serializer:
        $ref: '#/definitions/SerializerTypes'
  Subscription:
    description: A link to the related subscription
    type: object
    required:
      - subscription
    properties:
      subscription:
        $ref: '#/definitions/LinkType'
  TimingCaps.NtpServers.AuthenticationKeyNum:
    description: Authentication key number
    type: integer
    format: uint32
    example: 1
  TimingCaps.NtpServers.AuthenticationOption:
    description: NTP authentication option
    type: string
    enum:
      - NONE
      - SYMMETRIC_KEY
      - AUTO_KEY
    example: NONE
  TimingCaps.NtpServers.DelayReqMaxRate:
    description: Acceptable maximum rate of the Delay_Req messages in packets per second
    type: integer
    format: uint32
    example: 10
  TimingCaps.NtpServers.LocalPriority:
    description: NTP server local priority
    type: integer
    format: uint32
    example: 1
  TimingCaps.NtpServers.MaxPollingInterval:
    description: 'Maximum poll interval for NTP messages, in seconds as a power of two. Range 317'
    type: integer
    format: uint32
    example: 17
  TimingCaps.NtpServers.MinPollingInterval:
    description: 'Minimum poll interval for NTP messages, in seconds as a power of two. Range 317'
    type: integer
    format: uint32
    example: 3
  TimingCaps.NtpServers.NtpServerAddr:
    description: NTP server address
    type: string
    example: 192.0.2.0
  TimingCaps.NtpServers.NtpServerAddrType:
    description: Address type of NTP server
    type: string
    enum:
      - IP_ADDRESS
      - DNS_NAME
    example: IP_ADDRESS
  TimingCaps.NtpServers.PtpMasterIpAddress:
    description: PTP Master IP Address
    type: string
    example: 192.0.2.0
  TimingCaps.NtpServers.PtpMasterLocalPriority:
    description: PTP Master local priority
    type: integer
    format: uint32
    example: 1
  TimingCaps.NtpServers:
    description: NTP server detail.
    type: object
    required:
      - ntpServerAddrType
      - ntpServerAddr
      - minPollingInterval
      - maxPollingInterval
      - localPriority
      - authenticationOption
      - authenticationKeyNum
    properties:
      ntpServerAddrType:
        $ref: '#/definitions/TimingCaps.NtpServers.NtpServerAddrType'
      ntpServerAddr:
        $ref: '#/definitions/TimingCaps.NtpServers.NtpServerAddr'
      minPollingInterval:
        $ref: '#/definitions/TimingCaps.NtpServers.MinPollingInterval'
      maxPollingInterval:
        $ref: '#/definitions/TimingCaps.NtpServers.MaxPollingInterval'
      localPriority:
        $ref: '#/definitions/TimingCaps.NtpServers.LocalPriority'
      authenticationOption:
        $ref: '#/definitions/TimingCaps.NtpServers.AuthenticationOption'
      authenticationKeyNum:
        $ref: '#/definitions/TimingCaps.NtpServers.AuthenticationKeyNum'
  TimingCaps.PtpMasters:
    description: NTP server detail.
    type: object
    required:
      - ptpMasterIpAddress
      - ptpMasterLocalPriority
      - delayReqMaxRate
    properties:
      ptpMasterIpAddress:
        $ref: '#/definitions/TimingCaps.NtpServers.PtpMasterIpAddress'
      ptpMasterLocalPriority:
        $ref: '#/definitions/TimingCaps.NtpServers.PtpMasterLocalPriority'
      delayReqMaxRate:
        $ref: '#/definitions/TimingCaps.NtpServers.DelayReqMaxRate'
  TimingCaps.TimeStamp:
    description: time
    type: object
    required:
      - nanoSeconds
      - seconds
    properties:
      seconds:
        type: integer
        format: uint32
        description: 'The seconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC'
        example: 1577836800
      nanoSeconds: