deb-sahara/api-ref/source/job-types.inc
Shu Yingya 6ccc0997c7 [Api-ref] fix description of response parameters
There is something wrong in API ref, this changes fixed it:
1. change the response parameter description of "description",
   "id" and "name" and so on
2. some request parameter in the url path should be marked as
   "required"

Change-Id: I738fc5a3f490f9cc321349445249f7dcd9aaf4e7
Closes-Bug: 1636522
2017-02-07 20:04:16 +08:00

62 lines
1.1 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_plugin
- job_types: job_types
- name: plugin_name
Response Example
----------------
.. literalinclude:: samples/job-types/job-types-list-response.json
:language: javascript