Files
cloudkitty/doc/source/api-reference/v2/scope/scope_parameters.yml
Luka Peschke cb540872e8 Add a v2 API endpoint to get scope state
This adds a v2 API endpoint allowing to retrieve the state of several
scopes. It supports pagination and various filter.

Depends-On: https://review.opendev.org/#/c/658072
Change-Id: I3cb7f0554f7794eaaf2e7c35db6c36254bff96db
Story: 2005395
Task: 30789
2019-05-22 16:25:32 +02:00

73 lines
1.2 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
state:
in: body
description: |
State of the scope.
type: string
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