ironic/ironic/api/controllers/v1/driver.py

72 lines
2.1 KiB
Python

# Copyright 2013 Red Hat, Inc.
# 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 pecan
from pecan import rest
from wsme import types as wtypes
import wsmeext.pecan as wsme_pecan
from ironic.api.controllers.v1 import base
from ironic.openstack.common import log
LOG = log.getLogger(__name__)
class Driver(base.APIBase):
"""API representation of a driver."""
name = wtypes.text
"The name of the driver"
hosts = [wtypes.text]
"A list of active conductors that support this driver"
@classmethod
def convert(cls, name, hosts):
driver = Driver()
driver.name = name
driver.hosts = hosts
return driver
class DriverList(base.APIBase):
"""API representation of a list of drivers."""
drivers = [Driver]
"A list containing drivers objects"
@classmethod
def convert(cls, drivers):
collection = DriverList()
collection.drivers = [Driver.convert(dname, list(drivers[dname]))
for dname in drivers]
return collection
class DriversController(rest.RestController):
"""REST controller for Drivers."""
@wsme_pecan.wsexpose(DriverList)
def get_all(self):
"""Retrieve a list of drivers.
"""
# FIXME(deva): formatting of the auto-generated REST API docs
# will break from a single-line doc string.
# This is a result of a bug in sphinxcontrib-pecanwsme
# https://github.com/dreamhost/sphinxcontrib-pecanwsme/issues/8
driver_list = pecan.request.dbapi.get_active_driver_dict()
return DriverList.convert(driver_list)