Commit 9d2c84ca authored by Walter Featherstone's avatar Walter Featherstone
Browse files

Single apostrophe for string. Traffic Filter within TrafficRule changed to array

parent 17bdb30b
Loading
Loading
Loading
Loading
+41 −34
Original line number Diff line number Diff line
@@ -2,10 +2,10 @@
  "openapi": "3.0.0",
  "servers": [
    {
      "url": "http://127.0.0.1:8081/exampleAPI/mp1/v1/"
      "url": "http://127.0.0.1:8081/mp1/v1/"
    },
    {
      "url": "https://127.0.0.1:8081/exampleAPI/mp1/v1/"
      "url": "https://127.0.0.1:8081/mp1/v1/"
    }
  ],
  "info": {
@@ -445,7 +445,7 @@
      },
      "AppTerminationNotification.MaxGracefulTimeout": {
        "description": "Maximum timeout value in seconds for graceful termination or graceful stop of an application instance.",
        "type": "string",
        "type": "integer",
        "format": "uint32",
        "example": 10
      },
@@ -712,7 +712,7 @@
        "description": "Port portion of the address",
        "type": "integer",
        "format": "uint32",
        "example": "8080"
        "example": 8080
      },
      "EndPointInfo.Address": {
        "description": "A IP address and port pair",
@@ -1441,7 +1441,10 @@
            "$ref": "#/components/schemas/TrafficRule_Priority"
          },
          "trafficFilter": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TrafficFilter"
            }
          },
          "action": {
            "$ref": "#/components/schemas/TrafficRule.Action"
@@ -1537,7 +1540,7 @@
          "RPC_STREAMING",
          "WEBSOCKET"
        ],
        "example": "JSON"
        "example": "REST_HTTP"
      },
      "TunnelInfo.TunnelDstAddress": {
        "description": "Destination address of the tunnel",
@@ -2214,7 +2217,7 @@
            "id": "TransId12345",
            "name": "REST",
            "description": "REST API",
            "type": "JSON",
            "type": "REST_HTTP",
            "protocol": "HTTP",
            "version": "2.0",
            "endpoint": {
@@ -2224,7 +2227,7 @@
              "addresses": [
                {
                  "host": "192.0.2.0",
                  "port": "8080"
                  "port": 8080
                }
              ]
            },
@@ -2256,7 +2259,7 @@
              "id": "TransId12345",
              "name": "REST",
              "description": "REST API",
              "type": "JSON",
              "type": "REST_HTTP",
              "protocol": "HTTP",
              "version": "2.0",
              "endpoint": {
@@ -2266,7 +2269,7 @@
                "addresses": [
                  {
                    "host": "192.0.2.0",
                    "port": "8080"
                    "port": 8080
                  }
                ]
              },
@@ -2287,7 +2290,8 @@
          "serName": "ExampleService",
          "filterType": "FLOW",
          "priority": 1,
          "trafficFilter": {
          "trafficFilter": [
            {
              "srcAddress": [
                "192.168.2.0/24",
                "192.168.3.0/24"
@@ -2296,9 +2300,10 @@
                "192.127.4.100/32"
              ],
              "dstPort": [
              80
                "80"
              ]
          },
            }
          ],
          "action": "FORWARD_DECAPSULATED",
          "dstInterface": {
            "interfaceType": "IP",
@@ -2314,7 +2319,8 @@
            "serName": "ExampleService",
            "filterType": "FLOW",
            "priority": 1,
            "trafficFilter": {
            "trafficFilter": [
              {
                "srcAddress": [
                  "192.168.2.0/24",
                  "192.168.3.0/24"
@@ -2323,9 +2329,10 @@
                  "192.127.4.100/32"
                ],
                "dstPort": [
                80
                  "80"
                ]
            },
              }
            ],
            "action": "FORWARD_DECAPSULATED",
            "dstInterface": {
              "interfaceType": "IP",
+126 −124
Original line number Diff line number Diff line
openapi: 3.0.0
servers:
  - url: 'http://127.0.0.1:8081/exampleAPI/mp1/v1/'
  - url: 'https://127.0.0.1:8081/exampleAPI/mp1/v1/'
  - url: 'http://127.0.0.1:8081/mp1/v1/'
  - url: 'https://127.0.0.1:8081/mp1/v1/'
info:
  title: Mp1 API
  version: 1.1.1
@@ -316,13 +316,13 @@ components:
      description: >-
        Maximum timeout value in seconds for graceful termination or graceful
        stop of an application instance.
      type: string
      type: integer
      format: uint32
      example: 10
    AppTerminationNotification.NotificationType:
      description: Shall be set to AppTerminationNotification.
      type: string
      example: AppTerminationNotification
      example: 'AppTerminationNotification'
    AppTerminationNotification:
      description: >-
        This type represents the information that the mobile edge platform
@@ -343,7 +343,7 @@ components:
    AppTerminationNotificationSubscription.AppInstanceId:
      description: It is used as the filtering criterion for the subscribed events.
      type: string
      example: ID1
      example: 'ID1'
    AppTerminationNotificationSubscription.CallbackReference:
      description: >-
        URI selected by the mobile edge application instance to receive
@@ -378,23 +378,23 @@ components:
    AppTerminationNotificationSubscription.SubscriptionType:
      description: Shall be set to AppTerminationNotificationSubscription.
      type: string
      example: AppTerminationNotificationSubscription
      example: 'AppTerminationNotificationSubscription'
    CategoryRef.Href:
      description: Reference of the catalogue
      type: string
      example: catItem1
      example: 'catItem1'
    CategoryRef.Id:
      description: Unique identifier of the category
      type: string
      example: id12345
      example: 'id12345'
    CategoryRef.Name:
      description: Name of the category
      type: string
      example: RNI
      example: 'RNI'
    CategoryRef.Version:
      description: Category version
      type: string
      example: version1
      example: 'version1'
    CategoryRef:
      description: This type represents the category reference
      type: object
@@ -445,7 +445,7 @@ components:
            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
          example: 'TRACEABLE'
    DestinationInterface.InterfaceType:
      description: Type of the interface
      type: string
@@ -453,15 +453,15 @@ components:
        - TUNNEL
        - MAC
        - IP
      example: TUNNEL
      example: 'TUNNEL'
    DestinationInterface.IpAddress:
      description: IP address of the remote destination
      type: string
      example: 192.0.2.0
      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
      example: '02-00-00-00-00-00'
    DestinationInterface:
      description: This type represents the destination interface.
      type: object
@@ -481,29 +481,29 @@ components:
    DnsRule.DomainName:
      description: FQDN resolved by the DNS rule
      type: string
      example: www.example.com
      example: 'www.example.com'
    DnsRule.Id:
      description: Identifies the DNS Rule
      type: string
      example: dnsRule1
      example: 'dnsRule1'
    DnsRule.IpAddress:
      description: IP address associated with the FQDN resolved by the DNS rule
      type: string
      example: 192.0.2.0
      example: '192.0.2.0'
    DnsRule.IpAddressType:
      description: IP address type
      type: string
      enum:
        - IP_V6
        - IP_V4
      example: IP_V6
      example: 'IP_V6'
    DnsRule.State:
      description: DNS rule state
      type: string
      enum:
        - ACTIVE
        - INACTIVE
      example: ACTIVE
      example: 'ACTIVE'
    DnsRule.Ttl:
      description: Time to live value
      type: integer
@@ -534,12 +534,12 @@ components:
    EndPointInfo.Address.Host:
      description: Host portion of the address
      type: string
      example: 192.0.2.0
      example: '192.0.2.0'
    EndPointInfo.Address_Port:
      description: Port portion of the address
      type: integer
      format: uint32
      example: '8080'
      example: 8080
    EndPointInfo.Address:
      description: A IP address and port pair
      type: object
@@ -564,7 +564,7 @@ components:
      description: Entry point information of the service
      type: string
      format: uri
      example: /meMp1/service/EntryPoint
      example: '/meMp1/service/EntryPoint'
    EndPointInfo.Uris:
      description: >-
        Entry point information of the service as string, formatted according to
@@ -592,7 +592,7 @@ components:
      description: URI referring to a resource
      type: string
      format: uri
      example: /meMp1/example
      example: '/meMp1/example'
    Mp1SubscriptionLinkList.Links:
      description: Self-referring URI.
      type: object
@@ -675,12 +675,12 @@ components:
        - OAUTH2_IMPLICIT_GRANT
        - OAUTH2_RESOURCE_OWNER
        - OAUTH2_CLIENT_CREDENTIALS
      example: OAUTH2_CLIENT_CREDENTIALS
      example: 'OAUTH2_CLIENT_CREDENTIALS'
    SecurityInfo.OAuth2Info.TokenEndpoint:
      description: The token endpoint
      type: string
      format: uri
      example: /meMp1/security/TokenEndPoint
      example: '/meMp1/security/TokenEndPoint'
    SecurityInfo.OAuth2Info:
      description: Parameters related to use of OAuth 2.0
      required:
@@ -742,7 +742,7 @@ components:
    SerAvailabilityNotificationSubscription.SubscriptionType:
      description: Shall be set to SerAvailabilityNotificationSubscription.
      type: string
      example: SerAvailabilityNotificationSubscription
      example: 'SerAvailabilityNotificationSubscription'
    ServiceAvailabilityNotification:
      description: >-
        This type represents the service availability information.
@@ -775,20 +775,20 @@ components:
        platform.
      type: string
      readOnly: true
      example: ServiceInstance123
      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
      example: 'ExampleService'
    ServiceInfo.State:
      description: Contains the state
      type: string
      enum:
        - ACTIVE
        - INACTIVE
      example: ACTIVE
      example: 'ACTIVE'
    ServiceInfo.TransportId:
      description: >-
        Identifier of the platform-provided transport to be used by the service.
@@ -797,11 +797,11 @@ components:
        platform-provided transport for the service, and shall be absent
        otherwise.
      type: string
      example: Rest1
      example: 'Rest1'
    ServiceInfo.Version:
      description: Service version
      type: string
      example: ServiceVersion1
      example: 'ServiceVersion1'
    ServiceInfo:
      description: This type represents the general information of a mobile edge service.
      type: object
@@ -847,7 +847,7 @@ components:
        - NONE
        - SYMMETRIC_KEY
        - AUTO_KEY
      example: NONE
      example: 'NONE'
    TimingCaps.NtpServers.DelayReqMaxRate:
      description: Acceptable maximum rate of the Delay_Req messages in packets per second
      type: integer
@@ -875,18 +875,18 @@ components:
    TimingCaps.NtpServers.NtpServerAddr:
      description: NTP server address
      type: string
      example: 192.0.2.0
      example: '192.0.2.0'
    TimingCaps.NtpServers.NtpServerAddrType:
      description: Address type of NTP server
      type: string
      enum:
        - IP_ADDRESS
        - DNS_NAME
      example: IP_ADDRESS
      example: 'IP_ADDRESS'
    TimingCaps.NtpServers_PtpMasterIpAddress:
      description: PTP Master IP Address
      type: string
      example: 192.0.2.0
      example: '192.0.2.0'
    TimingCaps.NtpServers_PtpMasterLocalPriority:
      description: PTP Master local priority
      type: integer
@@ -974,7 +974,7 @@ components:
    TrafficFilter.Address:
      description: Identify the traffic ip address.
      type: string
      example: 192.168.1.1
      example: '192.168.1.1'
    TrafficFilter.DSCP:
      description: >-
        Used to match all IPv4 packets that have the same Differentiated
@@ -1094,7 +1094,7 @@ components:
        - PASSTHROUGH
        - DUPLICATE_DECAPSULATED
        - DUPLICATE_AS_IS
      example: DROP
      example: 'DROP'
    TrafficRule.FilterType:
      description: >-
        Definition of filter per FLOW or PACKET. If flow the filter match
@@ -1107,7 +1107,7 @@ components:
    TrafficRule.Id:
      description: Identify the traffic rule.
      type: string
      example: TrafficRule1
      example: 'TrafficRule1'
    TrafficRule_Priority:
      description: >-
        Priority of this traffic rule. If traffic rule conflicts, the one with
@@ -1121,7 +1121,7 @@ components:
      enum:
        - ACTIVE
        - INACTIVE
      example: ACTIVE
      example: 'ACTIVE'
    TrafficRule:
      description: This type represents the general information of a traffic rule.
      type: object
@@ -1140,6 +1140,8 @@ components:
        priority:
          $ref: '#/components/schemas/TrafficRule_Priority'
        trafficFilter:
          type: array
          items:
            $ref: '#/components/schemas/TrafficFilter'
        action:
          $ref: '#/components/schemas/TrafficRule.Action'
@@ -1150,22 +1152,22 @@ components:
    TransportInfo.Description:
      description: Human-readable description of this transport
      type: string
      example: REST API
      example: 'REST API'
    TransportInfo.Id:
      description: The identifier of this transport
      type: string
      example: TransId12345
      example: 'TransId12345'
    TransportInfo.ImplSpecificInfo:
      description: Additional implementation specific details of the transport
      type: object
    TransportInfo.Name:
      description: The name of this transport
      type: string
      example: REST
      example: 'REST'
    TransportInfo.Protocol:
      description: The name of the protocol used. Shall be set to HTTP for a REST API.
      type: string
      example: HTTP
      example: 'HTTP'
    TransportInfo.Version:
      description: The version of the protocol used
      type: string
@@ -1211,7 +1213,7 @@ components:
        - RPC
        - RPC_STREAMING
        - WEBSOCKET
      example: JSON
      example: 'REST_HTTP'
    TunnelInfo.TunnelDstAddress:
      description: Destination address of the tunnel
      type: string
@@ -1226,7 +1228,7 @@ components:
      enum:
        - GTP_U
        - GRE
      example: GTP_U
      example: 'GTP_U'
    TunnelInfo:
      description: This type represents the tunnel information.
      type: object
@@ -1673,115 +1675,115 @@ components:
  examples:
    DnsRule:
      value:
        dnsRuleId: DnsRule1
        domainName: www.example.com
        ipAddressType: IP_V4
        ipAddress: 146.241.7.3
        dnsRuleId: 'DnsRule1'
        domainName: 'www.example.com'
        ipAddressType: 'IP_V4'
        ipAddress: '146.241.7.3'
        ttl: 300
        state: ACTIVE
        state: 'ACTIVE'
    DnsRules:
      value:
        - dnsRuleId: DnsRule1
          domainName: www.example.com
          ipAddressType: IP_V4
          ipAddress: 146.241.7.3
        - dnsRuleId: 'DnsRule1'
          domainName: 'www.example.com'
          ipAddressType: 'IP_V4'
          ipAddress: '146.241.7.3'
          ttl: 300
          state: ACTIVE
          state: 'ACTIVE'
    ServiceInfo:
      value:
        serInstanceId: ServiceInstance123
        serName: ExampleService
        serInstanceId: 'ServiceInstance123'
        serName: 'ExampleService'
        serCategory:
          href: catItem1
          id: id12345
          name: RNI
          version: version1
        version: ServiceVersion1
        state: ACTIVE
        transportId: Rest1
          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
          id: 'TransId12345'
          name: 'REST'
          description: 'REST API'
          type: 'REST_HTTP'
          protocol: 'HTTP'
          version: '2.0'
          endpoint:
            uris:
              - /meMp1/service/EntryPoint
              - '/meMp1/service/EntryPoint'
            addresses:
              - host: 192.0.2.0
                port: '8080'
              - host: '192.0.2.0'
                port: 8080
          security:
            oAuth2Info:
              grantTypes: OAUTH2_CLIENT_CREDENTIALS
              tokenEndpoint: /meMp1/security/TokenEndPoint
        serializer: JSON
              grantTypes: 'OAUTH2_CLIENT_CREDENTIALS'
              tokenEndpoint: '/meMp1/security/TokenEndPoint'
        serializer: 'JSON'
    ServiceInfoList:
      value:
        - serInstanceId: ServiceInstance123
          serName: ExampleService
        - serInstanceId: 'ServiceInstance123'
          serName: 'ExampleService'
          serCategory:
            href: catItem1
            id: id12345
            name: RNI
            version: version1
          version: ServiceVersion1
          state: ACTIVE
          transportId: Rest1
            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
            id: 'TransId12345'
            name: 'REST'
            description: 'REST API'
            type: 'REST_HTTP'
            protocol: 'HTTP'
            version: '2.0'
            endpoint:
              uris:
                - /meMp1/service/EntryPoint
                - '/meMp1/service/EntryPoint'
              addresses:
                - host: 192.0.2.0
                  port: '8080'
                - host: '192.0.2.0'
                  port: 8080
            security:
              oAuth2Info:
                grantTypes: OAUTH2_CLIENT_CREDENTIALS
                tokenEndpoint: /meMp1/security/TokenEndPoint
          serializer: JSON
                grantTypes: 'OAUTH2_CLIENT_CREDENTIALS'
                tokenEndpoint: '/meMp1/security/TokenEndPoint'
          serializer: 'JSON'
    TrafficRule:
      value:
        trafficRuleId: TrafficRule123
        serName: ExampleService
        filterType: FLOW
        trafficRuleId: 'TrafficRule123'
        serName: 'ExampleService'
        filterType: 'FLOW'
        priority: 1
        trafficFilter:
          srcAddress:
            - 192.168.2.0/24
            - 192.168.3.0/24
          - srcAddress:
              - '192.168.2.0/24'
              - '192.168.3.0/24'
            dstAddress:
            - 192.127.4.100/32
              - '192.127.4.100/32'
            dstPort:
            - 80
        action: FORWARD_DECAPSULATED
              - '80'
        action: 'FORWARD_DECAPSULATED'
        dstInterface:
          interfaceType: IP
          dstIpAddress: 20.1.1.1
        state: ACTIVE
          interfaceType: 'IP'
          dstIpAddress: '20.1.1.1'
        state: 'ACTIVE'
    TrafficRules:
      value:
        - trafficRuleId: TrafficRule123
          serName: ExampleService
          filterType: FLOW
        - trafficRuleId: 'TrafficRule123'
          serName: 'ExampleService'
          filterType: 'FLOW'
          priority: 1
          trafficFilter:
            srcAddress:
              - 192.168.2.0/24
              - 192.168.3.0/24
            - srcAddress:
                - '192.168.2.0/24'
                - '192.168.3.0/24'
              dstAddress:
              - 192.127.4.100/32
                - '192.127.4.100/32'
              dstPort:
              - 80
          action: FORWARD_DECAPSULATED
                - '80'
          action: 'FORWARD_DECAPSULATED'
          dstInterface:
            interfaceType: IP
            dstIpAddress: 20.1.1.1
          state: ACTIVE
 No newline at end of file
            interfaceType: 'IP'
            dstIpAddress: '20.1.1.1'
          state: 'ACTIVE'
 No newline at end of file