Files
cloudkitty/doc/source/api-reference/v2/scope/scope_parameters.yml
Rafael Weingärtner 3a2623484e Add API to create scopes
This commit adds an API enabling the POST operation to create scopes in
an ad hoc fashion. This is useful for operators to register scopes
before they are created as resources in the collected backend so their
processing can be discarded right away, for example for trial
projects/accounts.

Otherwise, we need to wait for them to create resources, then for
example Ceilometer has to monitor these resources, persist measures in
Gnocchi, then CloudKitty has to discover the scopes and finally we can
disable their processing.

Change-Id: I3e947d36c9d5d5da07115d35dde578ae300cbe5c
2022-06-03 05:06:10 -03:00

128 lines
2.3 KiB
YAML

collector: &collector
in: query
description: |
Filter on collector.
type: string
required: false
fetcher: &fetcher
in: query
description: |
Filter on fetcher.
type: string
required: false
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
scope_key: &scope_key
in: query
description: |
Filter on scope_key.
type: string
required: false
active_anchor_query: &active_query
in: body
description: |
Defines if a scope should be processed or not; `True` means that
CloudKitty must process the scope.
type: bool
required: true
active_body:
<<: *active_query
required: false
active_key_resp:
<<: *active_query
all_scopes: &all_scopes
in: body
description: |
Confirmation whether all scopes must be reset
type: bool
collector_body:
<<: *collector
in: body
collector_resp:
<<: *collector
required: true
description: Collector for the given scope
in: body
fetcher_body:
<<: *fetcher
in: body
fetcher_resp:
<<: *fetcher
required: true
description: Fetcher for the given scope
in: body
last_processed_timestamp:
in: body
description: |
It represents the last processed timestamp for the storage state element.
type: iso8601 timestamp
required: true
scope_activation_toggle_date:
in: body
description: |
It represents the last time the scope was activated/deactivated via the
PATCH API.
type: iso8601 timestamp
required: true
scope_id_body:
<<: *scope_id
in: body
scope_id_resp:
<<: *scope_id
required: true
description: Scope
in: body
scope_key_body:
<<: *scope_key
in: body
scope_key_resp:
<<: *scope_key
required: true
description: Scope key for the given scope
in: body
state:
in: body
description: |
State of the scope. This variable represents the last processed
timestamp for the storage state element. It is DEPRECATED, and it will
be removed in upcoming releases. The alternative is
`last_processed_timestamp`.
type: iso8601 timestamp
required: true