ironic.api.controllers.root module

ironic.api.controllers.root module

class ironic.api.controllers.root.Root(**kw)[source]

Bases: ironic.api.controllers.base.APIBase

static convert()[source]
created_at

Complex type attribute definition.

Example:

class MyComplexType(wsme.types.Base):
    optionalvalue = int
    mandatoryvalue = wsattr(int, mandatory=True)
    named_value = wsattr(int, name='named.value')

After inspection, the non-wsattr attributes will be replaced, and the above class will be equivalent to:

class MyComplexType(wsme.types.Base):
    optionalvalue = wsattr(int)
    mandatoryvalue = wsattr(int, mandatory=True)
default_version

A link to the default version of the API

description

Some information about this API

name

The name of the API

updated_at

Complex type attribute definition.

Example:

class MyComplexType(wsme.types.Base):
    optionalvalue = int
    mandatoryvalue = wsattr(int, mandatory=True)
    named_value = wsattr(int, name='named.value')

After inspection, the non-wsattr attributes will be replaced, and the above class will be equivalent to:

class MyComplexType(wsme.types.Base):
    optionalvalue = wsattr(int)
    mandatoryvalue = wsattr(int, mandatory=True)
versions

Links to all the versions available in this API

class ironic.api.controllers.root.RootController[source]

Bases: pecan.rest.RestController

get(*args, **kwargs)[source]
v1 = <ironic.api.controllers.v1.Controller object>
class ironic.api.controllers.root.Version(id, min_version, version, status='CURRENT')[source]

Bases: ironic.api.controllers.base.APIBase

An API version representation.

This class represents an API version, including the minimum and maximum minor versions that are supported within the major version.

created_at

Complex type attribute definition.

Example:

class MyComplexType(wsme.types.Base):
    optionalvalue = int
    mandatoryvalue = wsattr(int, mandatory=True)
    named_value = wsattr(int, name='named.value')

After inspection, the non-wsattr attributes will be replaced, and the above class will be equivalent to:

class MyComplexType(wsme.types.Base):
    optionalvalue = wsattr(int)
    mandatoryvalue = wsattr(int, mandatory=True)
id

The ID of the (major) version, also acts as the release number

A Link that point to a specific version of the API

min_version

Minimum supported (major.minor) version of API.

status

Status of the version.

One of: * CURRENT - the latest version of API, * SUPPORTED - supported, but not latest, version of API, * DEPRECATED - supported, but deprecated, version of API.

updated_at

Complex type attribute definition.

Example:

class MyComplexType(wsme.types.Base):
    optionalvalue = int
    mandatoryvalue = wsattr(int, mandatory=True)
    named_value = wsattr(int, name='named.value')

After inspection, the non-wsattr attributes will be replaced, and the above class will be equivalent to:

class MyComplexType(wsme.types.Base):
    optionalvalue = wsattr(int)
    mandatoryvalue = wsattr(int, mandatory=True)
version

The current, maximum supported (major.minor) version of API.

Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.