File: modules.inc

package info (click to toggle)
cloudkitty 23.0.0-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 3,528 kB
  • sloc: python: 21,803; sh: 528; makefile: 226; pascal: 54
file content (111 lines) | stat: -rw-r--r-- 1,861 bytes parent folder | download | duplicates (3)
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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
=======================
Rating modules endpoint
=======================

Get the list of modules
=======================

Returns the list of all rating modules loaded. This method does not require any
parameter.

.. rest_method::  GET /v2/rating/modules

Status codes
------------

.. rest_status_code:: success http_status.yml

   - 200

.. rest_status_code:: error http_status.yml

   - 400
   - 401
   - 403

Response
--------

.. rest_parameters:: rating/modules_parameters.yml

   - modules: modules_list

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

.. literalinclude:: ./api_samples/rating/modules_list_get.json
   :language: javascript

Get one module
==============

Returns the details of one specific module. This method does not require any
parameter.

.. rest_method::  GET /v2/rating/modules/<module_id>

Status codes
------------

.. rest_status_code:: success http_status.yml

   - 200

.. rest_status_code:: error http_status.yml

   - 400
   - 401
   - 403
   - 404

Response
--------

.. rest_parameters:: rating/modules_parameters.yml

   - module_id: module_id
   - description: description
   - enabled: enabled
   - hot_config: hot_config
   - priority: priority

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

.. literalinclude:: ./api_samples/rating/module_get.json
   :language: javascript

Update one module
=================

.. rest_method::  PUT /v2/rating/modules/(module_id)

.. rest_parameters:: rating/modules_parameters.yml

   - enabled: enabled_opt
   - priority: priority_opt

Status codes
------------

.. rest_status_code:: success http_status.yml

   - 204

.. rest_status_code:: error http_status.yml

   - 400
   - 401
   - 403
   - 404

Response
--------

.. rest_parameters:: rating/modules_parameters.yml

   - module_id: module_id
   - description: description
   - enabled: enabled
   - hot_config: hot_config
   - priority: priority