ironic.api.validation package

Module contents

ironic.api.validation.api_version(min_version: int | None, max_version: int | None = None, message: str | None = None, exception_class: ~typing.Type[~webob.exc.HTTPException] = <class 'webob.exc.HTTPNotFound'>)[source]

Decorator for marking lower and upper bounds on API methods.

Parameters:

  • min_version – An integer representing the minimum API version that the API is available under.

  • max_version – An integer representing the maximum API version that the API is available under.

  • message – A message to return if the API is not supported.

  • exception_class – The exception class to raise if the API version is not supported (default is HTTPNotFound).