openstack/placement
Code Issues Proposed changes
Files
080bb81088814c5039bdcf1df8b59a25f01d671c
placement/nova/tests/functional/api_sample_tests
History
jichenjc 080bb81088 Verify os-aggregates.inc on sample files 
verified all sample files is correct and adjust
some format of the request Json file

part of bp:api-ref-in-rst

Change-Id: Ie9dd24858056337bcae9b03259d4f84de4fc1ab8
2016-07-26 02:06:28 +08:00
..
api_samples/os-aggregates
Verify os-aggregates.inc on sample files
2016-07-26 02:06:28 +08:00
README.rst
add api-samples tox target
2015-12-03 22:43:26 +00:00
test_aggregates.py
Verify os-aggregates.inc on sample files
2016-07-26 02:06:28 +08:00

README.rst

Api Samples

This part of the tree contains templates for API samples. The documentation in doc/api_samples is completely autogenerated from the tests in this directory.

To add a new api sample, add tests for the common passing and failing cases in this directory for your extension, and modify test_samples.py for your tests.

Then run the following command:

tox -e api-samples

Which will create the files on doc/api_samples.

If new tests are added or the .tpl files are changed due to bug fixes, the samples must be regenerated so they are in sync with the templates, as there is an additional test which reloads the documentation and ensures that it's in sync.

Debugging sample generation

If a .tpl is changed, its matching .json must be removed else the samples won't be generated. If an entirely new extension is added, a directory for it must be created before its samples will be generated.