654 lines
25 KiB
Python
654 lines
25 KiB
Python
# Copyright 2014 NEC Corporation. All rights reserved.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
import copy
|
|
|
|
from nova.api.validation import parameter_types
|
|
from nova.api.validation.parameter_types import multi_params
|
|
from nova.objects import instance
|
|
|
|
legacy_block_device_mapping = {
|
|
'type': 'object',
|
|
'properties': {
|
|
'virtual_name': {
|
|
'type': 'string', 'maxLength': 255,
|
|
},
|
|
'volume_id': parameter_types.volume_id,
|
|
'snapshot_id': parameter_types.image_id,
|
|
'volume_size': parameter_types.volume_size,
|
|
# Do not allow empty device names and number values and
|
|
# containing spaces(defined in nova/block_device.py:from_api())
|
|
'device_name': {
|
|
'type': 'string', 'minLength': 1, 'maxLength': 255,
|
|
'pattern': '^[a-zA-Z0-9._-r/]*$',
|
|
},
|
|
# Defined as boolean in nova/block_device.py:from_api()
|
|
'delete_on_termination': parameter_types.boolean,
|
|
'no_device': {},
|
|
# Defined as mediumtext in column "connection_info" in table
|
|
# "block_device_mapping"
|
|
'connection_info': {
|
|
'type': 'string', 'maxLength': 16777215
|
|
},
|
|
},
|
|
'additionalProperties': False
|
|
}
|
|
|
|
block_device_mapping_v2_new_item = {
|
|
# defined in nova/block_device.py:from_api()
|
|
# NOTE: Client can specify the Id with the combination of
|
|
# source_type and uuid, or a single attribute like volume_id/
|
|
# image_id/snapshot_id.
|
|
'source_type': {
|
|
'type': 'string',
|
|
'enum': ['volume', 'image', 'snapshot', 'blank'],
|
|
},
|
|
'uuid': {
|
|
'type': 'string', 'minLength': 1, 'maxLength': 255,
|
|
'pattern': '^[a-zA-Z0-9._-]*$',
|
|
},
|
|
'image_id': parameter_types.image_id,
|
|
'destination_type': {
|
|
'type': 'string',
|
|
'enum': ['local', 'volume'],
|
|
},
|
|
# Defined as varchar(255) in column "guest_format" in table
|
|
# "block_device_mapping"
|
|
'guest_format': {
|
|
'type': 'string', 'maxLength': 255,
|
|
},
|
|
# Defined as varchar(255) in column "device_type" in table
|
|
# "block_device_mapping"
|
|
'device_type': {
|
|
'type': 'string', 'maxLength': 255,
|
|
},
|
|
# Defined as varchar(255) in column "disk_bus" in table
|
|
# "block_device_mapping"
|
|
'disk_bus': {
|
|
'type': 'string', 'maxLength': 255,
|
|
},
|
|
# Defined as integer in nova/block_device.py:from_api()
|
|
# NOTE(mriedem): boot_index=None is also accepted for backward
|
|
# compatibility with the legacy v2 API.
|
|
'boot_index': {
|
|
'type': ['integer', 'string', 'null'],
|
|
'pattern': '^-?[0-9]+$',
|
|
},
|
|
}
|
|
|
|
block_device_mapping_v2 = copy.deepcopy(legacy_block_device_mapping)
|
|
block_device_mapping_v2['properties'].update(block_device_mapping_v2_new_item)
|
|
|
|
_hints = {
|
|
'type': 'object',
|
|
'properties': {
|
|
'group': {
|
|
'type': 'string',
|
|
'format': 'uuid'
|
|
},
|
|
'different_host': {
|
|
# NOTE: The value of 'different_host' is the set of server
|
|
# uuids where a new server is scheduled on a different host.
|
|
# A user can specify one server as string parameter and should
|
|
# specify multiple servers as array parameter instead.
|
|
'oneOf': [
|
|
{
|
|
'type': 'string',
|
|
'format': 'uuid'
|
|
},
|
|
{
|
|
'type': 'array',
|
|
'items': parameter_types.server_id
|
|
}
|
|
]
|
|
},
|
|
'same_host': {
|
|
# NOTE: The value of 'same_host' is the set of server
|
|
# uuids where a new server is scheduled on the same host.
|
|
'type': ['string', 'array'],
|
|
'items': parameter_types.server_id
|
|
},
|
|
'query': {
|
|
# NOTE: The value of 'query' is converted to dict data with
|
|
# jsonutils.loads() and used for filtering hosts.
|
|
'type': ['string', 'object'],
|
|
},
|
|
# NOTE: The value of 'target_cell' is the cell name what cell
|
|
# a new server is scheduled on.
|
|
'target_cell': parameter_types.name,
|
|
'different_cell': {
|
|
'type': ['string', 'array'],
|
|
'items': {
|
|
'type': 'string'
|
|
}
|
|
},
|
|
'build_near_host_ip': parameter_types.ip_address,
|
|
'cidr': {
|
|
'type': 'string',
|
|
'pattern': '^\/[0-9a-f.:]+$'
|
|
},
|
|
},
|
|
# NOTE: As this Mail:
|
|
# http://lists.openstack.org/pipermail/openstack-dev/2015-June/067996.html
|
|
# pointed out the limit the scheduler-hints in the API is problematic. So
|
|
# relax it.
|
|
'additionalProperties': True
|
|
}
|
|
|
|
base_create = {
|
|
'type': 'object',
|
|
'properties': {
|
|
'server': {
|
|
'type': 'object',
|
|
'properties': {
|
|
'name': parameter_types.name,
|
|
# NOTE(gmann): In case of boot from volume, imageRef was
|
|
# allowed as the empty string also So keeping the same
|
|
# behavior and allow empty string in case of boot from
|
|
# volume only. Python code make sure empty string is
|
|
# not allowed for other cases.
|
|
'imageRef': parameter_types.image_id_or_empty_string,
|
|
'flavorRef': parameter_types.flavor_ref,
|
|
'adminPass': parameter_types.admin_password,
|
|
'metadata': parameter_types.metadata,
|
|
'networks': {
|
|
'type': 'array',
|
|
'items': {
|
|
'type': 'object',
|
|
'properties': {
|
|
'fixed_ip': parameter_types.ip_address,
|
|
'port': {
|
|
'oneOf': [{'type': 'string', 'format': 'uuid'},
|
|
{'type': 'null'}]
|
|
},
|
|
'uuid': {'type': 'string'},
|
|
},
|
|
'additionalProperties': False,
|
|
}
|
|
},
|
|
'OS-DCF:diskConfig': parameter_types.disk_config,
|
|
'accessIPv4': parameter_types.accessIPv4,
|
|
'accessIPv6': parameter_types.accessIPv6,
|
|
'personality': parameter_types.personality,
|
|
'availability_zone': parameter_types.name,
|
|
'block_device_mapping': {
|
|
'type': 'array',
|
|
'items': legacy_block_device_mapping
|
|
},
|
|
'block_device_mapping_v2': {
|
|
'type': 'array',
|
|
'items': block_device_mapping_v2
|
|
},
|
|
'config_drive': parameter_types.boolean,
|
|
'key_name': parameter_types.name,
|
|
'min_count': parameter_types.positive_integer,
|
|
'max_count': parameter_types.positive_integer,
|
|
'return_reservation_id': parameter_types.boolean,
|
|
'security_groups': {
|
|
'type': 'array',
|
|
'items': {
|
|
'type': 'object',
|
|
'properties': {
|
|
# NOTE(oomichi): allocate_for_instance() of
|
|
# neutronv2/api.py gets security_group names
|
|
# or UUIDs from this parameter.
|
|
# parameter_types.name allows both format.
|
|
'name': parameter_types.name,
|
|
},
|
|
'additionalProperties': False,
|
|
}
|
|
},
|
|
'user_data': {
|
|
'type': 'string',
|
|
'format': 'base64',
|
|
'maxLength': 65535
|
|
}
|
|
},
|
|
'required': ['name', 'flavorRef'],
|
|
'additionalProperties': False,
|
|
},
|
|
'os:scheduler_hints': _hints,
|
|
'OS-SCH-HNT:scheduler_hints': _hints,
|
|
},
|
|
'required': ['server'],
|
|
'additionalProperties': False,
|
|
}
|
|
|
|
|
|
base_create_v20 = copy.deepcopy(base_create)
|
|
base_create_v20['properties']['server'][
|
|
'properties']['name'] = parameter_types.name_with_leading_trailing_spaces
|
|
base_create_v20['properties']['server']['properties'][
|
|
'availability_zone'] = parameter_types.name_with_leading_trailing_spaces
|
|
base_create_v20['properties']['server']['properties'][
|
|
'key_name'] = parameter_types.name_with_leading_trailing_spaces
|
|
base_create_v20['properties']['server']['properties'][
|
|
'security_groups']['items']['properties']['name'] = (
|
|
parameter_types.name_with_leading_trailing_spaces)
|
|
base_create_v20['properties']['server']['properties'][
|
|
'user_data'] = {
|
|
'oneOf': [{'type': 'string', 'format': 'base64', 'maxLength': 65535},
|
|
{'type': 'null'},
|
|
],
|
|
}
|
|
|
|
base_create_v219 = copy.deepcopy(base_create)
|
|
base_create_v219['properties']['server'][
|
|
'properties']['description'] = parameter_types.description
|
|
|
|
base_create_v232 = copy.deepcopy(base_create_v219)
|
|
base_create_v232['properties']['server'][
|
|
'properties']['networks']['items'][
|
|
'properties']['tag'] = parameter_types.tag
|
|
base_create_v232['properties']['server'][
|
|
'properties']['block_device_mapping_v2']['items'][
|
|
'properties']['tag'] = parameter_types.tag
|
|
|
|
# NOTE(artom) the following conditional was merged as
|
|
# "if version == '2.32'" The intent all along was to check whether
|
|
# version was greater than or equal to 2.32. In other words, we wanted
|
|
# to support tags in versions 2.32 and up, but ended up supporting them
|
|
# in version 2.32 only. Since we need a new microversion to add request
|
|
# body attributes, tags have been re-added in version 2.42.
|
|
|
|
# NOTE(gmann) Below schema 'base_create_v233' is added (builds on 2.19 schema)
|
|
# to keep the above mentioned behavior while merging the extension schema code
|
|
# into server schema file. Below is the ref code where BDM tag was originally
|
|
# got added for 2.32 microversion *only*.
|
|
# Ref- https://github.com/openstack/nova/blob/
|
|
# 9882a60e69a5ab8da314a199a56defc05098b743/nova/api/
|
|
# openstack/compute/block_device_mapping.py#L71
|
|
base_create_v233 = copy.deepcopy(base_create_v219)
|
|
base_create_v233['properties']['server'][
|
|
'properties']['networks']['items'][
|
|
'properties']['tag'] = parameter_types.tag
|
|
|
|
# 2.37 builds on 2.32 and makes the following changes:
|
|
# 1. server.networks is required
|
|
# 2. server.networks is now either an enum or a list
|
|
# 3. server.networks.uuid is now required to be a uuid
|
|
base_create_v237 = copy.deepcopy(base_create_v233)
|
|
base_create_v237['properties']['server']['required'].append('networks')
|
|
base_create_v237['properties']['server']['properties']['networks'] = {
|
|
'oneOf': [
|
|
{'type': 'array',
|
|
'items': {
|
|
'type': 'object',
|
|
'properties': {
|
|
'fixed_ip': parameter_types.ip_address,
|
|
'port': {
|
|
'oneOf': [{'type': 'string', 'format': 'uuid'},
|
|
{'type': 'null'}]
|
|
},
|
|
'uuid': {'type': 'string', 'format': 'uuid'},
|
|
},
|
|
'additionalProperties': False,
|
|
},
|
|
},
|
|
{'type': 'string', 'enum': ['none', 'auto']},
|
|
]}
|
|
|
|
|
|
# 2.42 builds on 2.37 and re-introduces the tag field to the list of network
|
|
# objects.
|
|
base_create_v242 = copy.deepcopy(base_create_v237)
|
|
base_create_v242['properties']['server']['properties']['networks'] = {
|
|
'oneOf': [
|
|
{'type': 'array',
|
|
'items': {
|
|
'type': 'object',
|
|
'properties': {
|
|
'fixed_ip': parameter_types.ip_address,
|
|
'port': {
|
|
'oneOf': [{'type': 'string', 'format': 'uuid'},
|
|
{'type': 'null'}]
|
|
},
|
|
'uuid': {'type': 'string', 'format': 'uuid'},
|
|
'tag': parameter_types.tag,
|
|
},
|
|
'additionalProperties': False,
|
|
},
|
|
},
|
|
{'type': 'string', 'enum': ['none', 'auto']},
|
|
]}
|
|
base_create_v242['properties']['server'][
|
|
'properties']['block_device_mapping_v2']['items'][
|
|
'properties']['tag'] = parameter_types.tag
|
|
|
|
|
|
# 2.52 builds on 2.42 and makes the following changes:
|
|
# Allowing adding tags to instances when booting
|
|
base_create_v252 = copy.deepcopy(base_create_v242)
|
|
base_create_v252['properties']['server']['properties']['tags'] = {
|
|
"type": "array",
|
|
"items": parameter_types.tag,
|
|
"maxItems": instance.MAX_TAG_COUNT
|
|
}
|
|
|
|
|
|
# 2.57 builds on 2.52 and removes the personality parameter.
|
|
base_create_v257 = copy.deepcopy(base_create_v252)
|
|
base_create_v257['properties']['server']['properties'].pop('personality')
|
|
|
|
|
|
# 2.63 builds on 2.57 and makes the following changes:
|
|
# Allowing adding trusted certificates to instances when booting
|
|
base_create_v263 = copy.deepcopy(base_create_v257)
|
|
base_create_v263['properties']['server']['properties'][
|
|
'trusted_image_certificates'] = parameter_types.trusted_certs
|
|
|
|
|
|
# Add volume type in block_device_mapping_v2.
|
|
base_create_v267 = copy.deepcopy(base_create_v263)
|
|
base_create_v267['properties']['server']['properties'][
|
|
'block_device_mapping_v2']['items'][
|
|
'properties']['volume_type'] = parameter_types.volume_type
|
|
|
|
|
|
base_update = {
|
|
'type': 'object',
|
|
'properties': {
|
|
'server': {
|
|
'type': 'object',
|
|
'properties': {
|
|
'name': parameter_types.name,
|
|
'OS-DCF:diskConfig': parameter_types.disk_config,
|
|
'accessIPv4': parameter_types.accessIPv4,
|
|
'accessIPv6': parameter_types.accessIPv6,
|
|
},
|
|
'additionalProperties': False,
|
|
},
|
|
},
|
|
'required': ['server'],
|
|
'additionalProperties': False,
|
|
}
|
|
|
|
|
|
base_update_v20 = copy.deepcopy(base_update)
|
|
base_update_v20['properties']['server'][
|
|
'properties']['name'] = parameter_types.name_with_leading_trailing_spaces
|
|
|
|
base_update_v219 = copy.deepcopy(base_update)
|
|
base_update_v219['properties']['server'][
|
|
'properties']['description'] = parameter_types.description
|
|
|
|
base_rebuild = {
|
|
'type': 'object',
|
|
'properties': {
|
|
'rebuild': {
|
|
'type': 'object',
|
|
'properties': {
|
|
'name': parameter_types.name,
|
|
'imageRef': parameter_types.image_id,
|
|
'adminPass': parameter_types.admin_password,
|
|
'metadata': parameter_types.metadata,
|
|
'preserve_ephemeral': parameter_types.boolean,
|
|
'OS-DCF:diskConfig': parameter_types.disk_config,
|
|
'accessIPv4': parameter_types.accessIPv4,
|
|
'accessIPv6': parameter_types.accessIPv6,
|
|
'personality': parameter_types.personality,
|
|
},
|
|
'required': ['imageRef'],
|
|
'additionalProperties': False,
|
|
},
|
|
},
|
|
'required': ['rebuild'],
|
|
'additionalProperties': False,
|
|
}
|
|
|
|
|
|
base_rebuild_v20 = copy.deepcopy(base_rebuild)
|
|
base_rebuild_v20['properties']['rebuild'][
|
|
'properties']['name'] = parameter_types.name_with_leading_trailing_spaces
|
|
|
|
base_rebuild_v219 = copy.deepcopy(base_rebuild)
|
|
base_rebuild_v219['properties']['rebuild'][
|
|
'properties']['description'] = parameter_types.description
|
|
|
|
base_rebuild_v254 = copy.deepcopy(base_rebuild_v219)
|
|
base_rebuild_v254['properties']['rebuild'][
|
|
'properties']['key_name'] = parameter_types.name_or_none
|
|
|
|
# 2.57 builds on 2.54 and makes the following changes:
|
|
# 1. Remove the personality parameter.
|
|
# 2. Add the user_data parameter which is nullable so user_data can be reset.
|
|
base_rebuild_v257 = copy.deepcopy(base_rebuild_v254)
|
|
base_rebuild_v257['properties']['rebuild']['properties'].pop('personality')
|
|
base_rebuild_v257['properties']['rebuild']['properties']['user_data'] = ({
|
|
'oneOf': [
|
|
{'type': 'string', 'format': 'base64', 'maxLength': 65535},
|
|
{'type': 'null'}
|
|
]
|
|
})
|
|
|
|
# 2.63 builds on 2.57 and makes the following changes:
|
|
# Allowing adding trusted certificates to instances when rebuilding
|
|
base_rebuild_v263 = copy.deepcopy(base_rebuild_v257)
|
|
base_rebuild_v263['properties']['rebuild']['properties'][
|
|
'trusted_image_certificates'] = parameter_types.trusted_certs
|
|
|
|
resize = {
|
|
'type': 'object',
|
|
'properties': {
|
|
'resize': {
|
|
'type': 'object',
|
|
'properties': {
|
|
'flavorRef': parameter_types.flavor_ref,
|
|
'OS-DCF:diskConfig': parameter_types.disk_config,
|
|
},
|
|
'required': ['flavorRef'],
|
|
'additionalProperties': False,
|
|
},
|
|
},
|
|
'required': ['resize'],
|
|
'additionalProperties': False,
|
|
}
|
|
|
|
create_image = {
|
|
'type': 'object',
|
|
'properties': {
|
|
'createImage': {
|
|
'type': 'object',
|
|
'properties': {
|
|
'name': parameter_types.name,
|
|
'metadata': parameter_types.metadata
|
|
},
|
|
'required': ['name'],
|
|
'additionalProperties': False
|
|
}
|
|
},
|
|
'required': ['createImage'],
|
|
'additionalProperties': False
|
|
}
|
|
|
|
|
|
create_image_v20 = copy.deepcopy(create_image)
|
|
create_image_v20['properties']['createImage'][
|
|
'properties']['name'] = parameter_types.name_with_leading_trailing_spaces
|
|
|
|
|
|
reboot = {
|
|
'type': 'object',
|
|
'properties': {
|
|
'reboot': {
|
|
'type': 'object',
|
|
'properties': {
|
|
'type': {
|
|
'type': 'string',
|
|
'enum': ['HARD', 'Hard', 'hard', 'SOFT', 'Soft', 'soft']
|
|
}
|
|
},
|
|
'required': ['type'],
|
|
'additionalProperties': False
|
|
}
|
|
},
|
|
'required': ['reboot'],
|
|
'additionalProperties': False
|
|
}
|
|
|
|
trigger_crash_dump = {
|
|
'type': 'object',
|
|
'properties': {
|
|
'trigger_crash_dump': {
|
|
'type': 'null'
|
|
}
|
|
},
|
|
'required': ['trigger_crash_dump'],
|
|
'additionalProperties': False
|
|
}
|
|
|
|
|
|
JOINED_TABLE_QUERY_PARAMS_SERVERS = {
|
|
'block_device_mapping': parameter_types.common_query_param,
|
|
'services': parameter_types.common_query_param,
|
|
'metadata': parameter_types.common_query_param,
|
|
'system_metadata': parameter_types.common_query_param,
|
|
'info_cache': parameter_types.common_query_param,
|
|
'security_groups': parameter_types.common_query_param,
|
|
'pci_devices': parameter_types.common_query_param
|
|
}
|
|
|
|
# These fields are valid values for sort_keys before we start
|
|
# using schema validation, but are considered to be bad values
|
|
# and disabled to use. In order to avoid backward incompatibility,
|
|
# they are ignored instead of return HTTP 400.
|
|
SERVER_LIST_IGNORE_SORT_KEY = [
|
|
'architecture', 'cell_name', 'cleaned', 'default_ephemeral_device',
|
|
'default_swap_device', 'deleted', 'deleted_at', 'disable_terminate',
|
|
'ephemeral_gb', 'ephemeral_key_uuid', 'id', 'key_data', 'launched_on',
|
|
'locked', 'memory_mb', 'os_type', 'reservation_id', 'root_gb',
|
|
'shutdown_terminate', 'user_data', 'vcpus', 'vm_mode'
|
|
]
|
|
|
|
# From microversion 2.73 we start offering locked as a valid sort key.
|
|
SERVER_LIST_IGNORE_SORT_KEY_V273 = list(SERVER_LIST_IGNORE_SORT_KEY)
|
|
SERVER_LIST_IGNORE_SORT_KEY_V273.remove('locked')
|
|
|
|
VALID_SORT_KEYS = {
|
|
"type": "string",
|
|
"enum": ['access_ip_v4', 'access_ip_v6', 'auto_disk_config',
|
|
'availability_zone', 'config_drive', 'created_at',
|
|
'display_description', 'display_name', 'host', 'hostname',
|
|
'image_ref', 'instance_type_id', 'kernel_id', 'key_name',
|
|
'launch_index', 'launched_at', 'locked_by', 'node', 'power_state',
|
|
'progress', 'project_id', 'ramdisk_id', 'root_device_name',
|
|
'task_state', 'terminated_at', 'updated_at', 'user_id', 'uuid',
|
|
'vm_state'] +
|
|
SERVER_LIST_IGNORE_SORT_KEY
|
|
}
|
|
|
|
# We reuse the existing list and add locked to the list of valid sort keys.
|
|
VALID_SORT_KEYS_V273 = {
|
|
"type": "string",
|
|
"enum": ['locked'] + list(
|
|
set(VALID_SORT_KEYS["enum"]) - set(SERVER_LIST_IGNORE_SORT_KEY)) +
|
|
SERVER_LIST_IGNORE_SORT_KEY_V273
|
|
}
|
|
|
|
query_params_v21 = {
|
|
'type': 'object',
|
|
'properties': {
|
|
'user_id': parameter_types.common_query_param,
|
|
'project_id': parameter_types.common_query_param,
|
|
# The alias of project_id. It should be removed in the
|
|
# future with microversion bump.
|
|
'tenant_id': parameter_types.common_query_param,
|
|
'launch_index': parameter_types.common_query_param,
|
|
# The alias of image. It should be removed in the
|
|
# future with microversion bump.
|
|
'image_ref': parameter_types.common_query_param,
|
|
'image': parameter_types.common_query_param,
|
|
'kernel_id': parameter_types.common_query_regex_param,
|
|
'ramdisk_id': parameter_types.common_query_regex_param,
|
|
'hostname': parameter_types.common_query_regex_param,
|
|
'key_name': parameter_types.common_query_regex_param,
|
|
'power_state': parameter_types.common_query_regex_param,
|
|
'vm_state': parameter_types.common_query_param,
|
|
'task_state': parameter_types.common_query_param,
|
|
'host': parameter_types.common_query_param,
|
|
'node': parameter_types.common_query_regex_param,
|
|
'flavor': parameter_types.common_query_regex_param,
|
|
'reservation_id': parameter_types.common_query_regex_param,
|
|
'launched_at': parameter_types.common_query_regex_param,
|
|
'terminated_at': parameter_types.common_query_regex_param,
|
|
'availability_zone': parameter_types.common_query_regex_param,
|
|
# NOTE(alex_xu): This is pattern matching, it didn't get any benefit
|
|
# from DB index.
|
|
'name': parameter_types.common_query_regex_param,
|
|
# The alias of name. It should be removed in the future
|
|
# with microversion bump.
|
|
'display_name': parameter_types.common_query_regex_param,
|
|
'description': parameter_types.common_query_regex_param,
|
|
# The alias of description. It should be removed in the
|
|
# future with microversion bump.
|
|
'display_description': parameter_types.common_query_regex_param,
|
|
'locked_by': parameter_types.common_query_regex_param,
|
|
'uuid': parameter_types.common_query_param,
|
|
'root_device_name': parameter_types.common_query_regex_param,
|
|
'config_drive': parameter_types.common_query_regex_param,
|
|
'access_ip_v4': parameter_types.common_query_regex_param,
|
|
'access_ip_v6': parameter_types.common_query_regex_param,
|
|
'auto_disk_config': parameter_types.common_query_regex_param,
|
|
'progress': parameter_types.common_query_regex_param,
|
|
'sort_key': multi_params(VALID_SORT_KEYS),
|
|
'sort_dir': parameter_types.common_query_param,
|
|
'all_tenants': parameter_types.common_query_param,
|
|
'soft_deleted': parameter_types.common_query_param,
|
|
'deleted': parameter_types.common_query_param,
|
|
'status': parameter_types.common_query_param,
|
|
'changes-since': multi_params({'type': 'string',
|
|
'format': 'date-time'}),
|
|
# NOTE(alex_xu): The ip and ip6 are implemented in the python.
|
|
'ip': parameter_types.common_query_regex_param,
|
|
'ip6': parameter_types.common_query_regex_param,
|
|
'created_at': parameter_types.common_query_regex_param,
|
|
},
|
|
# For backward-compatible additionalProperties is set to be True here.
|
|
# And we will either strip the extra params out or raise HTTP 400
|
|
# according to the params' value in the later process.
|
|
'additionalProperties': True,
|
|
# Prevent internal-attributes that are started with underscore from
|
|
# being striped out in schema validation, and raise HTTP 400 in API.
|
|
'patternProperties': {"^_": parameter_types.common_query_param}
|
|
}
|
|
|
|
# Update the joined-table fields to the list so it will not be
|
|
# stripped in later process, thus can be handled later in api
|
|
# to raise HTTP 400.
|
|
query_params_v21['properties'].update(
|
|
JOINED_TABLE_QUERY_PARAMS_SERVERS)
|
|
|
|
query_params_v21['properties'].update(
|
|
parameter_types.pagination_parameters)
|
|
|
|
query_params_v226 = copy.deepcopy(query_params_v21)
|
|
query_params_v226['properties'].update({
|
|
'tags': parameter_types.common_query_regex_param,
|
|
'tags-any': parameter_types.common_query_regex_param,
|
|
'not-tags': parameter_types.common_query_regex_param,
|
|
'not-tags-any': parameter_types.common_query_regex_param,
|
|
})
|
|
|
|
query_params_v266 = copy.deepcopy(query_params_v226)
|
|
query_params_v266['properties'].update({
|
|
'changes-before': multi_params({'type': 'string',
|
|
'format': 'date-time'}),
|
|
})
|
|
|
|
query_params_v273 = copy.deepcopy(query_params_v266)
|
|
query_params_v273['properties'].update({
|
|
'sort_key': multi_params(VALID_SORT_KEYS_V273),
|
|
'locked': parameter_types.common_query_param,
|
|
})
|