From eae07ef1d14fb77c65b2b86f6002d8f553fb72c1 Mon Sep 17 00:00:00 2001 From: Renat Akhmerov Date: Wed, 14 Oct 2015 12:55:23 +0600 Subject: [PATCH] Adding section about validation into API v2 spec Change-Id: I88f0eeb188cc531327311cfb900502eb64a0d2df Closes-Bug: #1505620 --- doc/source/developer/webapi/v2.rst | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/doc/source/developer/webapi/v2.rst b/doc/source/developer/webapi/v2.rst index 635561eae..b26face4c 100644 --- a/doc/source/developer/webapi/v2.rst +++ b/doc/source/developer/webapi/v2.rst @@ -121,7 +121,7 @@ When a Task starts Mistral creates a set of Action Executions. So Action Executi :webprefix: /v2/tasks Cron Triggers ------------------ +------------- Cron trigger is an object that allows to run Mistral workflows according to a time pattern (Unix crontab patterns format). Once a trigger is created it will run a specified workflow according to its properties: pattern, first_execution_time and remaining_executions. @@ -188,3 +188,16 @@ There are three service groups according to Mistral architecture currently, name .. rest-controller:: mistral.api.controllers.v2.service:ServicesController :webprefix: /v2/services + +Validation +---------- + +Validation endpoints allow to check correctness of workbook and workflow DSL without having to upload them into Mistral. + +**POST /v2/workbooks/validation** + Validate workbook content (DSL grammar and semantics). + +**POST /v2/workflows/validation** + Validate workflow content (DSL grammar and semantics). + +These endpoints expect workbook or workflow text (DSL) correspondingly in a request body. \ No newline at end of file