[ZBX-11436] API example for "action.create" contradicts documentation and results in invalid DB entries Created: 2016 Nov 08  Updated: 2024 Apr 10  Resolved: 2017 Nov 30

Status: Closed
Project: ZABBIX BUGS AND ISSUES
Component/s: Documentation (D)
Affects Version/s: 3.2.1
Fix Version/s: 3.4.5rc1, 4.0.0alpha1, 4.0 (plan)

Type: Documentation task Priority: Trivial
Reporter: Ilya Kruchinin Assignee: Natalja Cernohajeva (Inactive)
Resolution: Fixed Votes: 1
Labels: api, frontend, trivial
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified
Environment:

Debian 8


Attachments: PNG File Clipboard.png    
Team: Team A
Sprint: Sprint 21, Sprint 22

 Description   

There is discrepancy between documentation and example section for "action.create".
The text API documentation available at: https://www.zabbix.com/documentation/3.2/manual/api/reference/action/object lists "opmessage" as "required for message operations".
However, the example section provides an API example that:
1) for alert notification, contains "opmessage" parameter
2) for recovery notification, does NOT contain "opmessage" parameter

If API call is invoked as guide by "example", the "action" gets created successfully (without "opmessage" parameter set for recovery message), BUT editing such an action via web interface will fail (see screenshot).

I believe either the example must be fixed or API calls must fail if "opmessage" is not present for "Send message" type API calls.



 Comments   
Comment by Ilya Kruchinin [ 2016 Nov 08 ]

Example section with missing "opmessage" for recovery notifications: https://www.zabbix.com/documentation/3.2/manual/api/reference/action/create

Comment by Ilya Kruchinin [ 2016 Nov 08 ]

From the example section of documentation (results in issues with DB if implemented this way, unable to edit/update - see attached screenshot)

"recovery_operations": [

{ "operationtype": "11" }

]

Comment by vitalijs.cemeris (Inactive) [ 2016 Nov 14 ]

(1) [D] 3.2 action.create example should be changed so that recovery operation has "opmessage" parameter when "operationtype" equals 11.

RESOLVED

natalja.cernohajeva: checked. The mentioned example has been already fixed before me a while ago (for Zabbix version 3.2). Same problem found in Zabbix versions 3.4 and 4.0. Fixed both.
RESOLVED

sasha CLOSED

Generated at Wed Apr 02 22:54:12 EEST 2025 using Jira 9.12.4#9120004-sha1:625303b708afdb767e17cb2838290c41888e9ff0.