Files
cloudkitty/doc/source/api-reference/v2/dataframes/dataframes_parameters.yml
Justin Ferrieu a81c01d6e2 Add a v2 API endpoint to retrieve DataFrame objects
A new endpoint has been made available to admin users or
scope owners on ``GET /v2/dataframes``. This will allow
end users to retrieve DataFrames in the form of JSON objects
from the CloudKitty storage backend.

Documentation and unit tests are included in this commit.

Change-Id: I784da5565d040f565945fa93d86dcef11faa72f9
2019-09-13 10:04:01 +02:00

56 lines
1009 B
YAML

dataframes_body:
in: body
description: |
List of dataframes to add.
type: list
required: true
dataframes_resp:
in: body
description: |
List of dataframes matching the query parameters.
type: list
required: true
total_resp:
in: body
description: |
Total of datapoints matching the query parameters.
type: int
required: true
limit:
in: query
description: |
For pagination. The maximum number of results to return.
type: int
required: false
offset:
in: query
description: |
For pagination. The index of the first element that should be returned.
type: int
required: false
filters:
in: query
description: |
Optional filters.
type: dict
required: false
begin:
in: query
description: |
Begin of the period for which the dataframes are required.
type: iso8601 timestamp
required: false
end:
in: query
description: |
End of the period for which the dataframes are required.
type: iso8601 timestamp
required: false