Files
cloudkitty/doc/source/api-reference/v2/scope/scope_parameters.yml
Justin Ferrieu d78ba8740e Add a v2 API endpoint to reset the state of different scopes
A new endpoint is available to admin users on ``PUT /v2/scope``
with relatively similar parameters that are to be found on the
``GET /v2/scope`` endpoint regarding filtering. This allows
end users to reset the scope state of several scopes at once
if they are willing to.

Story: 2005395
Task: 30790
Change-Id: I28ccd24c65163b3e1b59e478653b01b84f2bb1b0
2019-07-18 08:05:50 +00:00

79 lines
1.3 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
scope_id: &scope_id
in: query
description: |
Filter on scope.
type: string
required: false
fetcher: &fetcher
in: query
description: |
Filter on fetcher.
type: string
required: false
collector: &collector
in: query
description: |
Filter on collector.
type: string
required: false
scope_key: &scope_key
in: query
description: |
Filter on scope_key.
type: string
required: false
all_scopes: &all_scopes
in: body
description: |
Confirmation whether all scopes must be reset
type: bool
state:
in: body
description: |
State of the scope.
type: iso8601 timestamp
required: true
fetcher_resp:
<<: *fetcher
required: true
description: Fetcher for the given scope
in: body
scope_id_resp:
<<: *scope_id
required: true
description: Scope
in: body
collector_resp:
<<: *collector
required: true
description: Collector for the given scope
in: body
scope_key_resp:
<<: *scope_key
required: true
description: Scope key for the given scope
in: body