Files
octavia/api-ref/source/v2/provider.inc
Michael Johnson 87fca27e37 Fix version discovery for the Octavia API
This adds the required "links" part of the version discovery document.

Change-Id: I18e75116e1da47991d68b0842892f1036adec41a
Story: 2001796
Task: 12518
2018-07-08 14:19:04 -07:00

52 lines
832 B
ReStructuredText

.. -*- rst -*-
List Providers
==============
.. rest_method:: GET /v2/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