@itentialopensource/adapter-openstack_neutron/entities/Networks/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": "showNetworkDetails",
      "enum": [
        "showNetworkDetails",
        "updateNetwork",
        "deleteNetwork",
        "listNetworks",
        "createNetwork"
      ],
      "external_name": "ph_request_type"
    },
    "networkId": {
      "type": "string",
      "description": "The ID of the network.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "network_id"
    },
    "adminStateUp": {
      "type": "boolean",
      "description": "Filter the list result by the administrative state of the resource,\nwhich is up (true) or down (false).",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "admin_state_up"
    },
    "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"
    },
    "providerNetworkType": {
      "type": "string",
      "description": "Filter the list result by the type of physical network that this\nnetwork/segment is mapped to. For example, flat, vlan, vxlan,\nor gre. Valid values depend on a networking...(description truncated)",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "provider:network_type"
    },
    "providerPhysicalNetwork": {
      "type": "string",
      "description": "Filter the list result by the physical network where\nthis network/segment is implemented.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "provider:physical_network"
    },
    "providerSegmentationId": {
      "type": "number",
      "description": "Filter the list result by the ID of the isolated segment\non the physical network.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "provider:segmentation_id"
    },
    "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"
    },
    "routerExternal": {
      "type": "boolean",
      "description": "Filter the network list result based on whether the network has an\nexternal routing facility that’s not managed by the networking service.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "router:external"
    },
    "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"
    },
    "vlanTransparent": {
      "type": "boolean",
      "description": "Filter the network list by the VLAN transparency mode of the network,\nwhich is VLAN transparent (true) or not VLAN transparent (false).",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "vlan_transparent"
    },
    "isDefault": {
      "type": "boolean",
      "description": "Filter the network list result based on if the network is default pool\nor not.",
      "parse": false,
      "encode": false,
      "encrypt": {
        "type": "AES",
        "key": ""
      },
      "external_name": "is_default"
    },
    "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"
    },
    "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 network 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"
    }
  },
  "definitions": {}
}