File: dataframes.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 (85 lines) | stat: -rw-r--r-- 1,416 bytes parent folder | download | duplicates (5)
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
===================
Dataframes endpoint
===================

Add dataframes into the storage backend
=======================================

Add dataframes into the storage backend.

.. rest_method::  POST /v2/dataframes

.. rest_parameters:: dataframes/dataframes_parameters.yml

   - dataframes: dataframes_body

Request Example
---------------

In the body:

.. literalinclude:: ./api_samples/dataframes/dataframes_post.json
   :language: javascript

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

.. rest_status_code:: success http_status.yml

   - 204

.. rest_status_code:: error http_status.yml

   - 400
   - 401
   - 403
   - 405

Response
--------

No content is to be returned.

Get dataframes from the storage backend
============================================

Get dataframes from the storage backend.

.. rest_method::  GET /v2/dataframes

.. rest_parameters:: dataframes/dataframes_parameters.yml

   - limit: limit
   - offset: offset
   - begin: begin
   - end: end
   - filters: filters

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

.. rest_status_code:: success http_status.yml

   - 200

.. rest_status_code:: error http_status.yml

   - 400
   - 401
   - 403
   - 405

Response
--------

.. rest_parameters:: dataframes/dataframes_parameters.yml

   - total: total_resp
   - dataframes: dataframes_resp

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

.. literalinclude:: ./api_samples/dataframes/dataframes_get.json
   :language: javascript