glance/api-ref/source/v2/discovery-parameters.yaml
Brian Rosmaita 6537ff2136 Update v2/info/stores api-ref
Slight rewrite of the stores discovery section of the api-ref to
indicate which elements of the response are optional and to remove
mention of the store type from the descriptions.

Change-Id: I8261de878fcaff1e498f7a3e152df7d980d0560c
2019-06-04 09:02:52 -04:00

21 lines
738 B
YAML

stores:
description: |
A list of store objects, where each store object may contain the
following fields:
``id``
Operator-defined identifier for the store.
``description``
Operator-supplied description of this store.
``default`` (optional)
Only present on the default store. This is the store where image
data is placed if you do not indicate a specific store when supplying
data to the Image Service. (See the :ref:`Image data <image-data>`
and :ref:`Interoperable image import <image-import-process>` sections
for more information.)
``read-only`` (optional)
Included only when the store is read only.
in: body
required: true
type: array