Bases: object
An argument definition of an api entry
Data type
Default value if argument is omitted
True if the argument is mandatory
argument name
Bases: object
An api entry definition
The function arguments (list of FunctionArgument
)
If the body carry the datas of a single argument, its type
Function documentation
Dictionnary of protocol-specific options.
Returns the FunctionDefinition
of a method.
Returns a FunctionArgument
from its name
True if extra arguments should be ignored, NOT inserted in the kwargs of the function and not raise UnknownArgument exceptions
Function name
Return type
Status code
alias of ironic.api.functions.signature
Bases: object
Decorator that specify the argument types of an exposed function.
return_type – Type of the value returned by the function
argN – Type of the Nth argument
body – If the function takes a final argument that is supposed to be the request body by itself, its type.
status_code – HTTP return status code of the function.
ignore_extra_args – Allow extra/unknow arguments (default to False)
Most of the time this decorator is not supposed to be used directly, unless you are not using WSME on top of another framework.
If an adapter is used, it will provide either a specialised version of this decororator, either a new decorator named @wsexpose that takes the same parameters (it will in addition expose the function, hence its name).
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.