File: tasks-schemas.inc

package info (click to toggle)
glance 2%3A30.0.0-3
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 10,416 kB
  • sloc: python: 74,906; sh: 175; makefile: 111
file content (72 lines) | stat: -rw-r--r-- 1,345 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
.. -*- rst -*-

Task Schemas
************

Gets a JSON-schema document that represents an individual task and a
list of tasks.

.. _tasks-schema:

Show tasks schema
~~~~~~~~~~~~~~~~~

.. rest_method::  GET /v2/schemas/tasks

*(Since Images v2.2)*

Shows a JSON schema document that represents a list of *tasks*.

An tasks list entity is a container of entities containing abbreviated
information about individual tasks.

The following schema is solely an example. Consider only the
response to the API call as authoritative.

Normal response codes: 200

Error response codes: 401


Request
-------

This operation has no request parameters and does not accept a request body.


Response Example
----------------

.. literalinclude:: samples/schemas-tasks-list-response.json
   :language: json

.. _task-schema:

Show task schema
~~~~~~~~~~~~~~~~

.. rest_method::  GET /v2/schemas/task

*(Since Images v2.2)*

Shows a JSON schema document that represents an *task* entity.

The following schema is solely an example. Consider only the
response to the API call as authoritative.

Normal response codes: 200

Error response codes: 401


Request
-------

This operation has no request parameters and does not accept a request body.


Response Example
----------------

.. literalinclude:: samples/schemas-task-show-response.json
   :language: json