DocumentationHandler

class ramose.DocumentationHandler(api_manager)

Bases: object

This class provides the main structure for returning a human-readable documentation of all the operations described in the configuration files handled by the APIManager specified as input.

abstract get_documentation(*args, **dargs)

An abstract method that returns a string defining the human-readable documentation of the operations available in the input APIManager.

abstract store_documentation(file_path, *args, **dargs)

An abstract method that store in the input file path (parameter ‘file_path’) the human-readable documentation of the operations available in the input APIManager.

abstract get_index(*args, **dargs)

An abstract method that returns a string defining the index of all the various configuration files handled by the input APIManager.