OTRS API Documentation Improved

Martin Gruner01. Dec 2016 | Development

Disclaimer:

The practical examples presented in our technical blog (blog.otrs.com) and now in the expert category in our FAQ blog section serve as a source of ideas and documentation to show what is theoretically possible with OTRS in concrete scenarios or sometimes even for more exotic configurations. All configurations presented here were developed under laboratory conditions as a proof of concept. 

We can only guarantee testing and implementation of these concepts to be error-free and productive if implemented in a workshop with one of our OTRS consultants. Without this, the responsibility lies with the customer himself. Please note that configurations from older OTRS versions may not work in the newer ones.

Did you know that there is extensive documentation available on OTRS, including Perl and JavaScript API docs?

The Perl API documentation has seen some improvements recently, including

  • Improved table of contents
    bildschirmfoto-2016-12-01-um-09-24-24
  • Syntax highlighting for Perl code snippets
  • Function source code preview (by clicking on the [Source] link, you can directly view the method’s source code)
    bildschirmfoto-2016-12-01-um-09-26-30

A nice example for the improvements is the documentation for the ObjectManager in OTRS 6. More improvements to the Perl source code documentation will follow in the next weeks and months.

Your email address will not be published.