deb-sahara/api-ref/source/job-types.inc
Gökhan IŞIK c9681132a7 Replacement of project name in api-ref.
The keystone resource was renamed from 'tenant' to 'project',
this patch replaces 'tenant' with 'project' in api-ref
documents of sahara.

Change-Id: I1f41757b3ec90f88926681d4a0b7767764c37c4a
Closes-Bug: #1626678
2017-02-02 05:57:47 +00:00

62 lines
1.0 KiB
ReStructuredText

.. -*- rst -*-
=========
Job types
=========
Each plugin that supports EDP also supports specific job types.
Different versions of a plugin might actually support different job
types. Configuration options vary by plugin, version, and job type.
The job types provide information about which plugins support which
job types and how to configure the job types.
List job types
==============
.. rest_method:: GET /v1.1/{project_id}/job-types
Lists all job types.
You can use query parameters to filter the response.
Normal response codes: 200
Error response codes:
Request
-------
.. rest_parameters:: parameters.yaml
- project_id: url_project_id
- plugin: plugin
- version: version
- type: type
- hints: hints
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- versions: versions
- title: title
- description: description
- job_types: job_types
- name: name
Response Example
----------------
.. literalinclude:: samples/job-types/job-types-list-response.json
:language: javascript