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

link to related object pages in the api docs

    XMLWordPrintable

    Details

    • Type: Documentation task
    • Status: Closed
    • Priority: Trivial
    • Resolution: Fixed
    • Affects Version/s: 4.0.4rc2
    • Fix Version/s: 4.2 (plan)
    • Component/s: Documentation (D)
    • Labels:
      None
    • Team:
      Team D
    • Sprint:
      Sprint 56 (Sep 2019), Sprint 55 (Aug 2019), Sprint 49 (Feb 2019), Sprint 50 (Mar 2019), Sprint 51 (Apr 2019), Sprint 52 (May 2019), Sprint 53 (Jun 2019), Sprint 54 (Jul 2019), Sprint 57 (Oct 2019), Sprint 58 (Nov 2019), Sprint 59 (Dec 2019), Sprint 60 (Jan 2020), Sprint 61 (Feb 2020), Sprint 62 (Mar 2020)
    • Story Points:
      0

      Description

      As an example, see the host.get page. Notice that it has parameters like selectGroups and selectHttpTests.
      What data these additional flags could return is not documented in the host object page, as this information is found in the respective object pages, like the hostgroup object and the web scenario object pages.

      Two problems here:

      • The connection with those object pages is not obvious to inexperienced users, made harder by the fact that the web scenarios are selected with the parameter selectHttpTests, the object page calls them "web scenarios" but the URL has httptest.
      • Getting to the available field documentation requires manually looking up the respective methods.

      Suggestion - link to all the relevant object pages, for example:

      Return the host groups that the host belongs to in the groups property.

        Attachments

          Activity

            People

            Assignee:
            mgeneralova Marina Generalova
            Reporter:
            richlv richlv
            Votes:
            0 Vote for this issue
            Watchers:
            5 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved: