cloudkitty/api-ref/source/v2/dataframes/dataframes_parameters.yml
Mariusz Karpiarz 73a081355f Move API docs to api-ref/source
This is the first step towards moving API ref/docs to
https://docs.openstack.org/api

The `conf.py` file is a copy of the file from `doc/source` and all the
other files simply need moving to the new location.

Change-Id: I9ecf84b53274d9b86f05800fc9816de275f3e9c5
2022-12-09 16:01:13 +00:00

56 lines
1009 B
YAML

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
filters:
in: query
description: |
Optional filters.
type: dict
required: false
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
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