dc2509ba65
This adds a v2 API root to CloudKitty. An example endpoint along with some developer documentation has been added. The API root is now served with Flask instead of pecan. Change-Id: I4ede52dae531631f7fe708400def01bc08a64dec Story: 2004208 Task: 27717 Task: 27718 Task: 27719
62 lines
837 B
HTML
62 lines
837 B
HTML
================
|
|
Example endpoint
|
|
================
|
|
|
|
Get an example message
|
|
======================
|
|
|
|
Returns an example message.
|
|
|
|
.. rest_method:: GET /v2/example
|
|
|
|
Status codes
|
|
------------
|
|
|
|
.. rest_status_code:: success http_status.yml
|
|
|
|
- 200
|
|
|
|
.. rest_status_code:: error http_status.yml
|
|
|
|
- 405
|
|
|
|
Response
|
|
--------
|
|
|
|
.. rest_parameters:: example/example_parameters.yml
|
|
|
|
- msg: example_msg
|
|
|
|
|
|
Submit a fruit
|
|
==============
|
|
|
|
Returns the fruit you sent.
|
|
|
|
.. rest_method:: POST /v2/example
|
|
|
|
.. rest_parameters:: example/example_parameters.yml
|
|
|
|
- fruit: fruit
|
|
|
|
Status codes
|
|
------------
|
|
|
|
.. rest_status_code:: success http_status.yml
|
|
|
|
- 200
|
|
- 400
|
|
|
|
.. rest_status_code:: error http_status.yml
|
|
|
|
- 400
|
|
- 403: fruit_error
|
|
- 405
|
|
|
|
Response
|
|
--------
|
|
|
|
.. rest_parameters:: example/example_parameters.yml
|
|
|
|
- msg: fruit_msg
|