7 Commits

Author SHA1 Message Date
Dave Baird
995a1f547f Removed endpoint API class documentation code
- there is no standard way for a swagger spec to define descriptive
information for an endpoint API
- added markdown as a format to the autodoc script
- added some version information to autogenerated docs
2015-11-13 19:30:47 +01:00
Dave Baird
c097696276 Added more formats to autodoc output
- narrow
- wide
- POD
- HTML
2015-11-12 13:03:04 +01:00
Dave Baird
389ce144ef Improved documentation methods
- API classes have rudimentary class doc info and useful method doc info
- object classes have more detailed method and class info
- added more tests for doc methods
2015-11-12 00:36:30 +01:00
Dave Baird
2144cf5d31 Handle missing security spec more elegantly
- remove the optional auth_setup_handler() callback mechanism
- add _global_auth_setup() method on ApiClient to analyse config when
security spec not provided
- add methods on the Configuration class to abstract getting and setting
tokens
2015-11-11 13:43:40 +01:00
Dave Baird
c06af6d141 Documentation and automatic documentation
- added POD to Role.pm
- added README.md files translated from Role.pm POD
- added an autodoc script (based on AutoDoc.pm role). The script prints
a listing of the methods built in Role.pm
- added class_documentation() and method_documentation() accessors on
all object and API classes which return the documentation supplied in
the Swagger spec for the API
2015-11-09 23:04:59 +01:00
Dave Baird
49034946a0 Make class and method documentation available
Documentation from the swagger spec is available via methods
class_documentation() and method_documentation() on object and API
classes.
2015-11-09 17:04:19 +01:00
Dave Baird
f0f43f5fdf Fix method names clash in Moose Role
When flattening all endpoint API methods into a single class, some
method names may clash, e.g. every API has a new() method. So we skip
them, they must be accessed via the API method. Warnings are emitted to
document skipped methods.
2015-11-08 21:51:26 +01:00