tempest/api_schema/compute/v2/floating_ips.py

# 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.

list_floating_ips = {
    'status_code': [200],
    'response_body': {
        'type': 'object',
        'properties': {
            'floating_ips': {
                'type': 'array',
                'items': {
                    'type': 'object',
                    'properties': {
                        # NOTE: Now the type of 'id' is integer, but
                        # here allows 'string' also because we will be
                        # able to change it to 'uuid' in the future.
                        'id': {'type': ['integer', 'string']},
                        'pool': {'type': ['string', 'null']},
                        'instance_id': {'type': ['integer', 'string', 'null']},
                        'ip': {
                            'type': 'string',
                            'format': 'ip-address'
                        },
                        'fixed_ip': {
                            'type': ['string', 'null'],
                            'format': 'ip-address'
                        }
                    },
                    'required': ['id', 'pool', 'instance_id', 'ip', 'fixed_ip']
                }
            }
        },
        'required': ['floating_ips']
    }
}