Files
cloudkitty/doc/source/api-reference/v2/scope/scope_parameters.yml
Rafael Weingärtner 70114c829e Deprecate state field and propose last_processed_timestamp field
Changes the `state` field in `cloudkitty_storage_states` table.
The goal is to use a more descriptive and meaningful name.
The proposed new column name is `last_processed_timestamp`.

Depends-on: https://review.opendev.org/c/openstack/cloudkitty/+/793973
Depends-on: https://review.opendev.org/c/openstack/cloudkitty/+/797443

Change-Id: I9e29808dc5771a6455d3c564f080e8c2ec28dc72
Implements: https://review.opendev.org/c/openstack/cloudkitty-specs/+/771513
2021-06-23 10:57:00 -03:00

105 lines
1.8 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
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_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