placement/placement-api-ref/source/parameters.yaml
Chris Dent 5978b02539 [placement] add api-ref for GET /resource_providers
This provides simple documentation of the response body and query
parameters when listing resource providers.

Change-Id: Ic8db81b5f17d4c380b64b3da24e525297db18584
2017-03-24 15:16:16 +03:00

87 lines
2.0 KiB
YAML

member_of:
type: string
in: query
required: false
description: >
A comma-separated list of strings representing aggregate uuids.
The returned resource providers must be associated with at
least one of the aggregates identified by uuid.
resource_provider_name_query:
type: string
in: query
required: false
description: >
The name of a resource provider to filter the list.
resource_provider_uuid_query:
type: string
in: query
required: false
description: >
The uuid of a resource provider to filter the list.
resources_query:
type: string
in: query
required: false
description: |
A comma-separated list of strings indicating an amount of
resource of a specified class that a provider must have the
capacity to serve::
resources=VCPU:4,DISK_GB:64,MEMORY_MB:2048
resource_provider_generation:
type: integer
in: body
required: true
description: >
A consistent view marker that assists with the management of
concurrent resource provider updates.
resource_provider_links:
type: array
in: body
required: true
description: >
A list of links associated with one resource provider.
resource_provider_name:
type: string
in: body
required: true
description: >
The name of one resource provider.
resource_provider_uuid:
type: string
in: body
required: true
description: >
The UUID for one resource provider.
resource_providers:
type: array
in: body
required: true
description: >
A list of ``resource_provider`` objects.
version_id:
type: string
in: body
required: true
description: >
A common name for the version being described. Informative only.
version_max:
type: string
in: body
required: true
description: >
The maximum microversion that is supported.
version_min:
type: string
in: body
required: true
description: >
The minimum microversion that is supported.
versions:
type: array
in: body
required: true
description: >
A list of version objects that describe the API versions available.