API documentation should be more verbose

XMLWordPrintable

    • Type: Incident report
    • Resolution: Fixed
    • Priority: Trivial
    • None
    • Affects Version/s: None
    • Component/s: Documentation (D)
    • None

      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.

            Assignee:
            Martins Valkovskis
            Reporter:
            Timo A. Hummel
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

              Created:
              Updated:
              Resolved: