Uploaded image for project: 'ZABBIX BUGS AND ISSUES'
  1. ZABBIX BUGS AND ISSUES
  2. ZBX-4550

API documentation should be more verbose

    XMLWordPrintable

Details

    • Incident report
    • Status: Closed
    • Trivial
    • Resolution: Fixed
    • None
    • None
    • Documentation (D)
    • None

    Description

      I have noticed quite some problems with the API documentation, which should be fixed:

      • searchWildcardsEnabled: It is not clear which wildcard can be used.
      • The values "shorten", "refer", "extend" should be documented in a more verbose manner, probably with examples
      • Passing no "id" to the API call isn't caught by the API, instead, a strange error is returned (sorry, forgot which one)

      Also, is the source for the API documentation stored in some kind of text document, or is it only stored in the documentation wiki? I ask because I might want to contribute to the API documentation, but I'm not sure where to put the contributions.

      Attachments

        Activity

          People

            martins-v Martins Valkovskis
            felicitus Timo A. Hummel
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: