ironic.api.controllers.base module

class ironic.api.controllers.base.APIBase(**kw)[source]

Bases: ironic.api.controllers.base.Base

created_at

The time in UTC at which the object is created

updated_at

The time in UTC at which the object is updated

class ironic.api.controllers.base.AsDictMixin[source]

Bases: object

Mixin class adding an as_dict() method.

as_dict()[source]

Render this object as a dict of its fields.

class ironic.api.controllers.base.Base(**kw)[source]

Bases: ironic.api.controllers.base.AsDictMixin

Base type for complex types

unset_fields_except(except_list=None)[source]

Unset fields so they don’t appear in the message body.

Parameters

except_list – A list of fields that won’t be touched.

class ironic.api.controllers.base.Version(headers, default_version, latest_version)[source]

Bases: object

API Version object.

max_string = 'X-OpenStack-Ironic-API-Maximum-Version'

HTTP response header

min_string = 'X-OpenStack-Ironic-API-Minimum-Version'

HTTP response header

static parse_headers(headers, default_version, latest_version)[source]

Determine the API version requested based on the headers supplied.

Parameters
  • headers – webob headers

  • default_version – version to use if not specified in headers

  • latest_version – version to use if latest is requested

Returns

a tuple of (major, minor) version numbers

Raises

webob.HTTPNotAcceptable

string = 'X-OpenStack-Ironic-API-Version'

HTTP Header string carrying the requested version