[dev.icinga.com #10180] API actions do not follow REST guidelines

[icinga-migration]

This issue has been migrated from Redmine: https://dev.icinga.com/issues/10180

Created by jflach on 2015-09-21 10:12:34 +00:00

Assignee: jflach
Status: Resolved (closed on 2015-10-22 09:35:02 +00:00)
Target Version: 2.4.0
Last Update: 2015-10-22 13:51:35 +00:00 (in Redmine)

Icinga Version: 2.4.0
Backport?: No
Include in Changelog: 0

---

Rework actions line actions/endable-flapping and actions/disable-flapping to actions/flapping and control it via parameters

Changesets

2015-10-16 09:47:25 +00:00 by jflach 6a5db7e

Update apiactions

refs #10180

2015-10-22 09:33:26 +00:00 by jflach be320b2

Update API actions

fixes #10180
refs #9080

---

Parent Task: #9080

[icinga-migration]

Updated by mfriedrich on 2015-10-15 09:38:31 +00:00

• Priority changed from Normal to High

[icinga-migration]

Updated by mfriedrich on 2015-10-15 12:12:15 +00:00

• Status changed from New to Assigned

[icinga-migration]

Updated by mfriedrich on 2015-10-17 01:42:16 +00:00

See my comment in https://dev.icinga.org/issues/9080#note-10

[icinga-migration]

Updated by mfriedrich on 2015-10-19 09:35:10 +00:00

• Remove global actions
• Documentation
  • Drop the actions table, and move them into separate sub sections
  • add specific enable/disable actions by example and reference the object modify POST action

[icinga-migration]

Updated by jflach on 2015-10-19 11:32:54 +00:00

"Drop the actions table, and move them into separate sub sections"
Sounds overkill for most of them, there are only 14 actions left, ...

"add specific enable/disable actions by example and reference the object modify POST action"
... none of which enable or disable anything.

So maybe adding an additional example and a reference to external commands will do?

[icinga-migration]

Updated by mfriedrich on 2015-10-19 11:52:26 +00:00

No. Please split them into sections and add examples and requirements. The table is ugly and does not provide enough space to explain the required attributes. Please look into the objects query/modify/... sections for how it should look like.

An example for disabling notifications on a service could be written as follows:

In order to e.g. disable the notification for a service object send a modify POST request ([url...]) to the service object setting the attribute to false.

Similar example for global actions, but with the /v1/objects/icingaapplicakions/app url reference.

We must not reference the old external command interface but our api documentation must work on its own. Everything else is confusing.

[icinga-migration]

Updated by mfriedrich on 2015-10-22 08:13:41 +00:00

• Assigned to changed from jflach to mfriedrich

[icinga-migration]

Updated by mfriedrich on 2015-10-22 09:32:47 +00:00

• Assigned to changed from mfriedrich to jflach

I've reviewed the code, and changed the following:

• Removed whitespaces (trailing and wrong indent)
• Downtime and Comment remove actions require the downtime_id but not legacy_id
• Messages were missing "did ... for object 'name'"
• Several occasions where enclosing quotes for object names were missing
• Removed dead code

Everything else looks good, and we may proceed with the open documentation issues in #9080. I'll merge these changes to master and delete the feature branch.

[icinga-migration]

Updated by jflach on 2015-10-22 09:35:03 +00:00

• Status changed from Assigned to Resolved
• Done % changed from 0 to 100

Applied in changeset be320b2.

[icinga-migration]

Updated by mfriedrich on 2015-10-22 13:51:35 +00:00

• Backport? changed from TBD to No
• Include in Changelog changed from 1 to 0