Files
cloudkitty/doc/source/api-reference/v2/summary/summary_parameters.yml
Luka Peschke acd2fec6a1 Add a v2 summary endpoint
This adds an endpoint on /v2/summary, as a replacement for /v1/summary.
It allows to retrieve a summary from the cloudkitty, which can be grouped on
custom attributes and filters.

Change-Id: I99bff44b24d3dcec2da97281f0b491ac333ed395
Story: 2005664
Task: 30961
2019-06-26 15:05:28 +00:00

80 lines
1.4 KiB
YAML

limit:
in: query
description: |
For pagination. The maximum number of results to return.
type: int
required: false
offset: &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
groupby:
in: query
description: |
Optional attributes to group the summary by.
type: list of strings
required: false
begin: &begin
in: query
description: |
Begin of the period for which the summary is required.
type: iso8601 timestamp
required: false
end: &end
in: query
description: |
End of the period for which the summary is required.
type: iso8601 timestamp
required: false
qty: &qty
in: body
description: |
Qty for the item.
type: float
required: true
rate: &rate
in: body
description: |
Rate for the item.
type: float
required: true
begin_resp:
<<: *begin
required: true
description: Begin of the period for the item.
in: body
end_resp:
<<: *end
required: true
description: End of the period for the item.
in: body
qty_resp:
<<: *qty
required: true
description: Qty for the item in the specified period.
in: body
rate_resp:
<<: *rate
required: true
description: Rate for the item in the specified period.
in: body