6349976cde
This patch addresses the following: Fixes some unit tests. Cleans up some code from the parent patches, Adds a release note for the provider driver support. Adds the "List providers" API. Adds a document listing the know provider drivers. Adds a provider driver development guide. Change-Id: I90dc39e5e9d7d5839913dc2dbf187d935ee2b8b5 Story: 1655768 Task: 5165
52 lines
834 B
ReStructuredText
52 lines
834 B
ReStructuredText
.. -*- rst -*-
|
|
|
|
List Providers
|
|
==============
|
|
|
|
.. rest_method:: GET /v2.0/lbaas/providers
|
|
|
|
Lists all enabled provider drivers.
|
|
|
|
Use the ``fields`` query parameter to control which fields are
|
|
returned in the response body.
|
|
|
|
The list might be empty.
|
|
|
|
.. rest_status_code:: success ../http-status.yaml
|
|
|
|
- 200
|
|
|
|
.. rest_status_code:: error ../http-status.yaml
|
|
|
|
- 400
|
|
- 401
|
|
- 403
|
|
- 500
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: ../parameters.yaml
|
|
|
|
- fields: fields
|
|
|
|
Curl Example
|
|
------------
|
|
|
|
.. literalinclude:: examples/provider-list-curl
|
|
:language: bash
|
|
|
|
Response Parameters
|
|
-------------------
|
|
|
|
.. rest_parameters:: ../parameters.yaml
|
|
|
|
- name: provider-name
|
|
- description: provider-description
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: examples/provider-list-response.json
|
|
:language: javascript
|