73a081355f
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
128 lines
2.3 KiB
YAML
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
|