api-ref: Add webhook API reference

Change-Id: I75c5b2de55df276d414633f16ad9735a9871b59d Implements: blueprint event-driven-optimization-based
2020-02-06 14:43:16 +08:00 · 2020-02-06 14:43:16 +08:00 · 145fccdd23
parent ae83ef02e7
commit 145fccdd23
2 changed files with 27 additions and 0 deletions
--- a/api-ref/source/index.rst
+++ b/api-ref/source/index.rst
@ -16,3 +16,4 @@ Watcher API
 .. include:: watcher-api-v1-services.inc
 .. include:: watcher-api-v1-scoring_engines.inc
 .. include:: watcher-api-v1-datamodel.inc
+.. include:: watcher-api-v1-webhooks.inc
--- a/api-ref/source/watcher-api-v1-webhooks.inc
+++ b/api-ref/source/watcher-api-v1-webhooks.inc
@ -0,0 +1,26 @@
+.. -*- rst -*-
+
+========
+Webhooks
+========
+
+.. versionadded:: 1.4
+
+Triggers an event based Audit.
+
+
+Trigger EVENT Audit
+===================
+
+.. rest_method::  POST /v1/webhooks/{audit_ident}
+
+Normal response codes: 202
+
+Error codes: 400,404
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+   - audit_ident: audit_ident