Merge "api: Add response body schemas for volume attachments APIs"

Author: Zuul

nova/api/openstack/compute/schemas/volume_attachments.py

@@ -100,3 +100,135 @@
     'properties': {},
     'additionalProperties': True,
 }
+
+_volume_attachment_response = {
+    'type': 'object',
+    'properties': {
+        'id': parameter_types.volume_id,
+        'device': {
+            'type': ['string', 'null'],
+            # NOTE: The validation pattern from match_device() in
+            # nova/block_device.py.
+            'pattern': '(^/dev/x{0,1}[a-z]{0,1}d{0,1})([a-z]+)[0-9]*$'
+        },
+        'serverId': parameter_types.server_id,
+        'volumeId': parameter_types.volume_id,
+    },
+    'required': ['id', 'serverId', 'volumeId'],
+    'additionalProperties': False,
+}
+
+_volume_attachment_response_v270 = copy.deepcopy(_volume_attachment_response)
+_volume_attachment_response_v270['properties'].update({
+    'tag': {
+        'oneOf': [
+            parameter_types.tag,
+            {'type': 'null'},
+        ],
+    },
+})
+_volume_attachment_response_v270['required'].append('tag')
+
+_volume_attachment_response_v279 = copy.deepcopy(
+    _volume_attachment_response_v270
+)
+_volume_attachment_response_v279['properties'].update({
+    'delete_on_termination': parameter_types.boolean,
+})
+_volume_attachment_response_v279['required'].append('delete_on_termination')
+
+_volume_attachment_response_v289 = copy.deepcopy(
+    _volume_attachment_response_v279
+)
+del _volume_attachment_response_v289['properties']['id']
+_volume_attachment_response_v289['properties'].update({
+    'attachment_id': parameter_types.attachment_id,
+    'bdm_uuid': {'type': 'string', 'format': 'uuid'},
+})
+_volume_attachment_response_v289['required'].pop(
+    _volume_attachment_response_v289['required'].index('id')
+)
+_volume_attachment_response_v289['required'].extend(
+    ['attachment_id', 'bdm_uuid']
+)
+
+index_response = {
+    'type': 'object',
+    'properties': {
+        'volumeAttachments': {
+            'type': 'array',
+            'items': _volume_attachment_response,
+        },
+    },
+    'required': ['volumeAttachments'],
+    'additionalProperties': False,
+}
+
+index_response_v270 = copy.deepcopy(index_response)
+index_response_v270['properties']['volumeAttachments']['items'] = (
+    _volume_attachment_response_v270
+)
+
+index_response_v279 = copy.deepcopy(index_response_v270)
+index_response_v279['properties']['volumeAttachments']['items'] = (
+    _volume_attachment_response_v279
+)
+
+index_response_v289 = copy.deepcopy(index_response_v279)
+index_response_v289['properties']['volumeAttachments']['items'] = (
+    _volume_attachment_response_v289
+)
+
+show_response = {
+    'type': 'object',
+    'properties': {
+        'volumeAttachment': _volume_attachment_response,
+    },
+    'required': ['volumeAttachment'],
+    'additionalProperties': False,
+}
+
+show_response_v270 = copy.deepcopy(show_response)
+show_response_v270['properties']['volumeAttachment'] = (
+    _volume_attachment_response_v270
+)
+
+show_response_v279 = copy.deepcopy(show_response_v270)
+show_response_v279['properties']['volumeAttachment'] = (
+    _volume_attachment_response_v279
+)
+
+show_response_v289 = copy.deepcopy(show_response_v279)
+show_response_v289['properties']['volumeAttachment'] = (
+    _volume_attachment_response_v289
+)
+
+create_response = {
+    'type': 'object',
+    'properties': {
+        'volumeAttachment': _volume_attachment_response,
+    },
+    'required': ['volumeAttachment'],
+    'additionalProperties': False,
+}
+
+create_response_v270 = copy.deepcopy(create_response)
+create_response_v270['properties']['volumeAttachment'] = copy.deepcopy(
+    _volume_attachment_response_v270
+)
+# device is always shown in create responses, even if null
+create_response_v270['properties']['volumeAttachment'][
+    'required'
+].append('device')
+
+create_response_v279 = copy.deepcopy(create_response_v270)
+create_response_v279['properties']['volumeAttachment'] = copy.deepcopy(
+    _volume_attachment_response_v279
+)
+create_response_v279['properties']['volumeAttachment'][
+    'required'
+].append('device')
+
+update_response = {'type': 'null'}
+
+delete_response = {'type': 'null'}

nova/api/openstack/compute/volume_attachments.py

@@ -88,6 +88,7 @@ def _check_request_version(req, min_version, method, server_id, server_state):
         exc_inv, method, server_id)
 
 
+@validation.validated
 class VolumeAttachmentController(wsgi.Controller):
     """The volume attachment API controller for the OpenStack API.
 
@@ -104,6 +105,10 @@ def __init__(self):
     @wsgi.expected_errors(404)
     @validation.query_schema(schema.index_query, '2.0', '2.74')
     @validation.query_schema(schema.index_query_v275, '2.75')
+    @validation.response_body_schema(schema.index_response, '2.0', '2.69')
+    @validation.response_body_schema(schema.index_response_v270, '2.70', '2.78')  # noqa: E501
+    @validation.response_body_schema(schema.index_response_v279, '2.79', '2.88')  # noqa: E501
+    @validation.response_body_schema(schema.index_response_v289, '2.89')
     def index(self, req, server_id):
         """Returns the list of volume attachments for a given instance."""
         context = req.environ['nova.context']
@@ -136,6 +141,10 @@ def index(self, req, server_id):
 
     @wsgi.expected_errors(404)
     @validation.query_schema(schema.show_query)
+    @validation.response_body_schema(schema.show_response, '2.0', '2.69')
+    @validation.response_body_schema(schema.show_response_v270, '2.70', '2.78')  # noqa: E501
+    @validation.response_body_schema(schema.show_response_v279, '2.79', '2.88')  # noqa: E501
+    @validation.response_body_schema(schema.show_response_v289, '2.89')
     def show(self, req, server_id, id):
         """Return data about the given volume attachment."""
         context = req.environ['nova.context']
@@ -175,6 +184,9 @@ def show(self, req, server_id, id):
     @validation.schema(schema.create, '2.0', '2.48')
     @validation.schema(schema.create_v249, '2.49', '2.78')
     @validation.schema(schema.create_v279, '2.79')
+    @validation.response_body_schema(schema.create_response, '2.0', '2.69')
+    @validation.response_body_schema(schema.create_response_v270, '2.70', '2.78')  # noqa: E501
+    @validation.response_body_schema(schema.create_response_v279, '2.79')
     def create(self, req, server_id, body):
         """Attach a volume to an instance."""
         context = req.environ['nova.context']
@@ -234,6 +246,8 @@ def create(self, req, server_id, body):
             attachment['tag'] = tag
         if api_version_request.is_supported(req, '2.79'):
             attachment['delete_on_termination'] = delete_on_termination
+        # TODO(stephenfin): We forgot to apply 2.89 here. We should return
+        # 'bdm_uuid' and 'attachment_id' and stop returning 'id'
         return {'volumeAttachment': attachment}
 
     def _update_volume_swap(self, req, instance, id, body):
@@ -318,6 +332,7 @@ def _update_volume_regular(self, req, instance, id, body):
     @wsgi.expected_errors((400, 404, 409))
     @validation.schema(schema.update, '2.0', '2.84')
     @validation.schema(schema.update_v285, '2.85')
+    @validation.response_body_schema(schema.update_response)
     def update(self, req, server_id, id, body):
         context = req.environ['nova.context']
         instance = common.get_instance(self.compute_api, context, server_id)
@@ -348,6 +363,7 @@ def update(self, req, server_id, id, body):
 
     @wsgi.response(202)
     @wsgi.expected_errors((400, 403, 404, 409))
+    @validation.response_body_schema(schema.delete_response)
     def delete(self, req, server_id, id):
         """Detach a volume from an instance."""
         context = req.environ['nova.context']