[ZBXNEXT-3871] template api documentation improvements Created: 2017 May 13  Updated: 2024 Apr 10  Resolved: 2018 Mar 04

Status: Closed
Project: ZABBIX FEATURE REQUESTS
Component/s: Documentation (D)
Affects Version/s: 3.4.0alpha1
Fix Version/s: 4.0 (plan)

Type: Change Request Priority: Trivial
Reporter: richlv Assignee: Martins Valkovskis
Resolution: Fixed Votes: 0
Labels: templates
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Team: Team C
Sprint: Sprint 28
Story Points: 0

 Description   

template api documentation is great, but there are a few things that could make it more clear :

  • https://www.zabbix.com/documentation/3.2/manual/api/reference/template/massremove has parameters "templateids", "hostids", "templateids_clear" and "templateids_link".
    the "hostids" parameter actually includes both template and host ids. while a careful reader can decypher all these, it would be a bit easier if some of them had linkage direction specified, for example :
    "Hosts or templates to unlink the given templates from." -> "Hosts or templates to unlink the given templates from (downstream)."
    "Templates to unlink and clear from the given templates." -> "Templates to unlink and clear from the given templates (upstream)."
    "Templates to unlink from the given templates." -> "Templates to unlink from the given templates (upstream)."

it would be great if these could be applied to all the api documentation versions



 Comments   
Comment by Martins Valkovskis [ 2018 Feb 26 ]

Documentation updated in both cases for all currently supported versions (2.2, 3.0, 3.4) and 3.2 (the version in which the ticket was reported).

Generated at Fri Apr 26 18:18:58 EEST 2024 using Jira 9.12.4#9120004-sha1:625303b708afdb767e17cb2838290c41888e9ff0.