3426a6648a
This fixes all build warnings in the docs, and makes them build with -W (consider warnings as errors). Work items: * Remove the useless "METRICS_CONF" global variable in the monasca collector. It was causing the "load_conf()" function to fail, as the /etc/cloudkitty/metrics.yml file couldn't be found. * Change the docstring indentation in cloudkitty/rating/hash/controllers/mapping.py. This was the cause for the "doc/source/api-reference/v1/rating/hashmap.rst:12: WARNING: Field list ends without a blank line; unexpected unindent." message. * Added a cloudkitty.conf sample to the admin documentation. * Deleted unused files. * Fixed the policy.yaml sample include path. * Sorted the v2 API parameters alphabetically. * Ignored the "wsmeext.sphinxext: directive 'autoattribute' is already registered" warning * Added :noindex: directives to functions documented twice. * Made sphinx always build with -W. Change-Id: I5f1ab04e18920f3352c2807878cad327692a225f
95 lines
1.5 KiB
YAML
95 lines
1.5 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
|
|
|
|
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.
|
|
type: iso8601 timestamp
|
|
required: true
|