From 09402821f329dbc7833e07475c4ef6949ace86d8 Mon Sep 17 00:00:00 2001 From: Noa Koffman Date: Tue, 13 Sep 2016 10:11:31 +0000 Subject: [PATCH] Fix mistral API docs Fixing v2.rst to refer to new module paths, and adding the cron trigger param to POST v2/cron_triggers/ documentation. Change-Id: Iaef285d39d2f70d69dfccbe8b33dd965c719a8a0 --- doc/source/developer/webapi/v2.rst | 36 +++++++++++----------- mistral/api/controllers/v2/cron_trigger.py | 6 +++- 2 files changed, 23 insertions(+), 19 deletions(-) diff --git a/doc/source/developer/webapi/v2.rst b/doc/source/developer/webapi/v2.rst index 5cabace0f..fd26a9a45 100644 --- a/doc/source/developer/webapi/v2.rst +++ b/doc/source/developer/webapi/v2.rst @@ -29,12 +29,12 @@ All API v2 urls are relative to API v2 root. Workbooks --------- -.. autotype:: mistral.api.controllers.v2.workbook.Workbook +.. autotype:: mistral.api.controllers.v2.resources.Workbook :members: `name` is immutable. tags is a list of values associated with a workbook that a user can use to group workbooks by some criteria (deployment workbooks, Big Data processing workbooks etc.). Note that name and tags get inferred from workbook definition when Mistral service receives a POST request. So they can't be changed in another way. -.. autotype:: mistral.api.controllers.v2.workbook.Workbooks +.. autotype:: mistral.api.controllers.v2.resources.Workbooks :members: .. rest-controller:: mistral.api.controllers.v2.workbook:WorkbooksController @@ -44,12 +44,12 @@ Workbooks Workflows --------- -.. autotype:: mistral.api.controllers.v2.workflow.Workflow +.. autotype:: mistral.api.controllers.v2.resources.Workflow :members: `name` is immutable. tags is a list of values associated with a workflow that a user can use to group workflows by some criteria. Note that name and tags get inferred from workflow definition when Mistral service receives a POST request. So they can't be changed in another way. -.. autotype:: mistral.api.controllers.v2.workflow.Workflows +.. autotype:: mistral.api.controllers.v2.resources.Workflows :members: .. rest-controller:: mistral.api.controllers.v2.workflow:WorkflowsController @@ -58,10 +58,10 @@ Workflows Actions ------- -.. autotype:: mistral.api.controllers.v2.action.Action +.. autotype:: mistral.api.controllers.v2.resources.Action :members: -.. autotype:: mistral.api.controllers.v2.action.Actions +.. autotype:: mistral.api.controllers.v2.resources.Actions :members: .. rest-controller:: mistral.api.controllers.v2.action:ActionsController @@ -71,10 +71,10 @@ Actions Executions ---------- -.. autotype:: mistral.api.controllers.v2.execution.Execution +.. autotype:: mistral.api.controllers.v2.resources.Execution :members: -.. autotype:: mistral.api.controllers.v2.execution.Executions +.. autotype:: mistral.api.controllers.v2.resources.Executions :members: .. rest-controller:: mistral.api.controllers.v2.execution:ExecutionsController @@ -87,10 +87,10 @@ Tasks When a workflow starts Mistral creates an execution. It in turn consists of a set of tasks. So Task is an instance of a task described in a Workflow that belongs to a particular execution. -.. autotype:: mistral.api.controllers.v2.task.Task +.. autotype:: mistral.api.controllers.v2.resources.Task :members: -.. autotype:: mistral.api.controllers.v2.task.Tasks +.. autotype:: mistral.api.controllers.v2.resources.Tasks :members: .. rest-controller:: mistral.api.controllers.v2.task:TasksController @@ -106,10 +106,10 @@ Action Executions When a Task starts Mistral creates a set of Action Executions. So Action Execution is an instance of an action call described in a Workflow Task that belongs to a particular execution. -.. autotype:: mistral.api.controllers.v2.action_execution.ActionExecution +.. autotype:: mistral.api.controllers.v2.resources.ActionExecution :members: -.. autotype:: mistral.api.controllers.v2.action_execution.ActionExecutions +.. autotype:: mistral.api.controllers.v2.resources.ActionExecutions :members: .. rest-controller:: mistral.api.controllers.v2.action_execution:ActionExecutionsController @@ -124,10 +124,10 @@ 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. -.. autotype:: mistral.api.controllers.v2.cron_trigger.CronTrigger +.. autotype:: mistral.api.controllers.v2.resources.CronTrigger :members: -.. autotype:: mistral.api.controllers.v2.cron_trigger.CronTriggers +.. autotype:: mistral.api.controllers.v2.resources.CronTriggers :members: .. rest-controller:: mistral.api.controllers.v2.cron_trigger:CronTriggersController @@ -161,10 +161,10 @@ Example of creating action defaults:: Note: using CLI, Environment can be created via JSON or YAML file. -.. autotype:: mistral.api.controllers.v2.environment.Environment +.. autotype:: mistral.api.controllers.v2.resources.Environment :members: -.. autotype:: mistral.api.controllers.v2.environment.Environments +.. autotype:: mistral.api.controllers.v2.resources.Environments :members: .. rest-controller:: mistral.api.controllers.v2.environment:EnvironmentController @@ -178,10 +178,10 @@ Through service management API, system administrator or operator can retrieve Mi There are three service groups according to Mistral architecture currently, namely api_group, engine_group and executor_group. The service identifier contains name of the host the service is running on and the process identifier of the service on that host. -.. autotype:: mistral.api.controllers.v2.service.Service +.. autotype:: mistral.api.controllers.v2.resources.Service :members: -.. autotype:: mistral.api.controllers.v2.service.Services +.. autotype:: mistral.api.controllers.v2.resources.Services :members: .. rest-controller:: mistral.api.controllers.v2.service:ServicesController diff --git a/mistral/api/controllers/v2/cron_trigger.py b/mistral/api/controllers/v2/cron_trigger.py index 711b7703d..079a99809 100644 --- a/mistral/api/controllers/v2/cron_trigger.py +++ b/mistral/api/controllers/v2/cron_trigger.py @@ -49,7 +49,11 @@ class CronTriggersController(rest.RestController): status_code=201 ) def post(self, cron_trigger): - """Creates a new cron trigger.""" + """Creates a new cron trigger. + + :param cron_trigger: Required. Cron trigger structure. + + """ acl.enforce('cron_triggers:create', context.ctx()) LOG.info('Create cron trigger: %s' % cron_trigger)