openstack/mistral
Code Issues Proposed changes

Merge "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."

Browse Source
This commit is contained in:
Jenkins 2016-09-13 18:22:05 +00:00 committed by Gerrit Code Review
commit 6c657c9ec9
2 changed files with 23 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
doc/source/developer/webapi/v2.rst
View File

@ -29,12 +29,12 @@ All API v2 urls are relative to API v2 root.
Workbooks Workbooks
--------- ---------
.. autotype:: mistral.api.controllers.v2.workbook.Workbook .. autotype:: mistral.api.controllers.v2.resources.Workbook
:members: :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. `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: :members:
.. rest-controller:: mistral.api.controllers.v2.workbook:WorkbooksController .. rest-controller:: mistral.api.controllers.v2.workbook:WorkbooksController
@ -44,12 +44,12 @@ Workbooks
Workflows Workflows
--------- ---------
.. autotype:: mistral.api.controllers.v2.workflow.Workflow .. autotype:: mistral.api.controllers.v2.resources.Workflow
:members: :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. `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: :members:
.. rest-controller:: mistral.api.controllers.v2.workflow:WorkflowsController .. rest-controller:: mistral.api.controllers.v2.workflow:WorkflowsController
@ -58,10 +58,10 @@ Workflows
Actions Actions
------- -------
.. autotype:: mistral.api.controllers.v2.action.Action .. autotype:: mistral.api.controllers.v2.resources.Action
:members: :members:
.. autotype:: mistral.api.controllers.v2.action.Actions .. autotype:: mistral.api.controllers.v2.resources.Actions
:members: :members:
.. rest-controller:: mistral.api.controllers.v2.action:ActionsController .. rest-controller:: mistral.api.controllers.v2.action:ActionsController
@ -71,10 +71,10 @@ Actions
Executions Executions
---------- ----------
.. autotype:: mistral.api.controllers.v2.execution.Execution .. autotype:: mistral.api.controllers.v2.resources.Execution
:members: :members:
.. autotype:: mistral.api.controllers.v2.execution.Executions .. autotype:: mistral.api.controllers.v2.resources.Executions
:members: :members:
.. rest-controller:: mistral.api.controllers.v2.execution:ExecutionsController .. 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. 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: :members:
.. autotype:: mistral.api.controllers.v2.task.Tasks .. autotype:: mistral.api.controllers.v2.resources.Tasks
:members: :members:
.. rest-controller:: mistral.api.controllers.v2.task:TasksController .. 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. 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: :members:
.. autotype:: mistral.api.controllers.v2.action_execution.ActionExecutions .. autotype:: mistral.api.controllers.v2.resources.ActionExecutions
:members: :members:
.. rest-controller:: mistral.api.controllers.v2.action_execution:ActionExecutionsController .. 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. 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: :members:
.. autotype:: mistral.api.controllers.v2.cron_trigger.CronTriggers .. autotype:: mistral.api.controllers.v2.resources.CronTriggers
:members: :members:
.. rest-controller:: mistral.api.controllers.v2.cron_trigger:CronTriggersController .. 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. 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: :members:
.. autotype:: mistral.api.controllers.v2.environment.Environments .. autotype:: mistral.api.controllers.v2.resources.Environments
:members: :members:
.. rest-controller:: mistral.api.controllers.v2.environment:EnvironmentController .. 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. 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: :members:
.. autotype:: mistral.api.controllers.v2.service.Services .. autotype:: mistral.api.controllers.v2.resources.Services
:members: :members:
.. rest-controller:: mistral.api.controllers.v2.service:ServicesController .. rest-controller:: mistral.api.controllers.v2.service:ServicesController

6
mistral/api/controllers/v2/cron_trigger.py
View File

@ -49,7 +49,11 @@ class CronTriggersController(rest.RestController):
status_code=201 status_code=201
) )
def post(self, cron_trigger): 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()) acl.enforce('cron_triggers:create', context.ctx())
LOG.info('Create cron trigger: %s' % cron_trigger) LOG.info('Create cron trigger: %s' % cron_trigger)