@itentialopensource/adapter-openstack_neutron/entities/Subnets/schema.json

This adapter integrates with system described as: Openstack Networking (Neutron) Service

{
  "$id": "schema.json",
  "type": "object",
  "schema": "http://json-schema.org/draft-07/schema#",
  "translate": true,
  "dynamicfields": true,
  "properties": {
    "ph_request_type": {
      "type": "string",
      "description": "type of request (internal to adapter)",
      "default": "listSubnets",
      "enum": [
        "listSubnets",
        "createSubnet",
        "showSubnetDetails",
        "updateSubnet",
        "deleteSubnet"
      ],
      "external_name": "ph_request_type"
    },
    "tenantId": {
      "type": "string",
      "description": "Filter the list result by the ID of the project that owns the resource.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "tenant_id"
    },
    "projectId": {
      "type": "string",
      "description": "Filter the list result by the ID of the project that owns the resource.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "project_id"
    },
    "enableDhcp": {
      "type": "boolean",
      "description": "Filter the subnet list result based on if DHCP is enabled or disabled\nfor the subnet.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "enable_dhcp"
    },
    "networkId": {
      "type": "string",
      "description": "Filter the subnet list result by the ID of the network to which\nthe subnet belongs.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "network_id"
    },
    "ipVersion": {
      "type": "number",
      "description": "Filter the subnet list result by the IP protocol version.\nValue is 4 or 6.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "ip_version"
    },
    "gatewayIp": {
      "type": "string",
      "description": "Filter the subnet list result by the gateway IP of this subnet.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "gateway_ip"
    },
    "ipv6AddressMode": {
      "type": "string",
      "description": "Filter the subnet list result by the IPv6 address modes specifies\nmechanisms for assigning IP addresses.\nValue is slaac, dhcpv6-stateful, dhcpv6-stateless or null.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "ipv6_address_mode"
    },
    "ipv6RaMode": {
      "type": "string",
      "description": "Filter the subnet list result by the IPv6 router advertisement specifies\nwhether the networking service should transmit ICMPv6 packets for a subnet.\nValue is slaac, dhcpv...(description truncated)",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "ipv6_ra_mode"
    },
    "revisionNumber": {
      "type": "number",
      "description": "Filter the list result by the revision number of the resource.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "revision_number"
    },
    "segmentId": {
      "type": "string",
      "description": "Filter the subnet list result by the ID of a network segment the subnet\nis associated with.\nIt is available when segment extension is enabled.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "segment_id"
    },
    "sortDir": {
      "type": "string",
      "description": "Sort direction. A valid value is asc (ascending) or desc\n(descending). You can specify multiple pairs of sort key and\nsort direction query parameters.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "sort_dir"
    },
    "sortKey": {
      "type": "string",
      "description": "Sorts by a subnet attribute. You can specify multiple pairs of sort key\nand sort direction query parameters. The sort keys are limited to:",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "sort_key"
    },
    "subnetpoolId": {
      "type": "string",
      "description": "Filter the subnet list result by the ID of the subnet pool associated\nwith the subnet.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "subnetpool_id"
    },
    "tagsAny": {
      "type": "string",
      "description": "A list of tags to filter the list result by.\nResources that match any tag in this list will be returned.\nTags in query must be separated by comma.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "tags-any"
    },
    "notTags": {
      "type": "string",
      "description": "A list of tags to filter the list result by.\nResources that match all tags in this list will be excluded.\nTags in query must be separated by comma.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "not-tags"
    },
    "notTagsAny": {
      "type": "string",
      "description": "A list of tags to filter the list result by.\nResources that match any tag in this list will be excluded.\nTags in query must be separated by comma.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "not-tags-any"
    },
    "dnsPublishFixedIp": {
      "type": "boolean",
      "description": "Filter the subnet list result based on if dns_publish_fixed_ip is\nenabled or disabled for the subnet.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "dns_publish_fixed_ip"
    },
    "subnetId": {
      "type": "string",
      "description": "The ID of the subnet.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "subnet_id"
    }
  },
  "definitions": {}
}