Schema network-address-translations.json

Show original (referenced schemas with $ref)

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "description": "A list of network address translation policies.",
    "items": {
        "$schema": "http://json-schema.org/draft-04/schema#",
        "description": "Describes a simple network address translation policy for IP Addresses and/or Ports.",
        "properties": {
            "id": {
                "description": "Globally unique identifier for translation policy",
                "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
                "type": "string"
            },
            "label": {
                "description": "Translation policy name.",
                "type": "string"
            },
            "match": {
                "allOf": [
                    {
                        "dependencies": {
                            "destination_port": [
                                "destination_ip"
                            ],
                            "source_port": [
                                "source_ip"
                            ]
                        }
                    },
                    {
                        "$schema": "http://json-schema.org/draft-04/schema#",
                        "additionalProperties": false,
                        "description": "Describes the 4-tuple of IP Addresses and/or Ports to be matched or translated to.",
                        "minProperties": 1,
                        "properties": {
                            "destination_ip": {
                                "anyOf": [
                                    {
                                        "format": "ipv4"
                                    },
                                    {
                                        "format": "ipv6"
                                    }
                                ],
                                "description": "Destination IP address",
                                "type": "string"
                            },
                            "destination_port": {
                                "description": "Destination port",
                                "maximum": 65535,
                                "minimum": 1,
                                "type": "integer"
                            },
                            "source_ip": {
                                "anyOf": [
                                    {
                                        "format": "ipv4"
                                    },
                                    {
                                        "format": "ipv6"
                                    }
                                ],
                                "description": "Sender IP address",
                                "type": "string"
                            },
                            "source_port": {
                                "description": "Sender port",
                                "maximum": 65535,
                                "minimum": 1,
                                "type": "integer"
                            }
                        },
                        "title": "Network address translation 4-tuple",
                        "type": "object"
                    }
                ]
            },
            "receiver_endpoint_ids": {
                "description": "List of receiver endpoint IDs.",
                "items": {
                    "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
                    "type": "string"
                },
                "minItems": 0,
                "type": "array",
                "uniqueItems": true
            },
            "translated": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "additionalProperties": false,
                "description": "Describes the 4-tuple of IP Addresses and/or Ports to be matched or translated to.",
                "minProperties": 1,
                "properties": {
                    "destination_ip": {
                        "anyOf": [
                            {
                                "format": "ipv4"
                            },
                            {
                                "format": "ipv6"
                            }
                        ],
                        "description": "Destination IP address",
                        "type": "string"
                    },
                    "destination_port": {
                        "description": "Destination port",
                        "maximum": 65535,
                        "minimum": 1,
                        "type": "integer"
                    },
                    "source_ip": {
                        "anyOf": [
                            {
                                "format": "ipv4"
                            },
                            {
                                "format": "ipv6"
                            }
                        ],
                        "description": "Sender IP address",
                        "type": "string"
                    },
                    "source_port": {
                        "description": "Sender port",
                        "maximum": 65535,
                        "minimum": 1,
                        "type": "integer"
                    }
                },
                "title": "Network address translation 4-tuple",
                "type": "object"
            }
        },
        "required": [
            "id",
            "match",
            "translated",
            "receiver_endpoint_ids"
        ],
        "title": "Network address translation policy",
        "type": "object"
    },
    "minItems": 0,
    "title": "List of network address translation policies.",
    "type": "array",
    "uniqueItems": true
}

Documentation built at 13:05:31 CDT on 2023-07-12.
(c) AMWA 2023. RAML/JSON licensed under Apache 2.0. Documentation licensed under CC BY-ND 4.0.