Files
deb-nova/nova/tests/functional/api_sample_tests
Pavel Kholkin 260bb7cbf6 test_keypairs_list_for_different_users for v2.10
Added functional api_sample_test for keypair-list command
for different users for microversion v2.10

Closes-Bug: #1599904

Change-Id: I92cd06efeafb00f5f4678e94185789026896be3a
2016-08-29 17:12:15 +03:00
..
2015-08-15 12:30:20 +10:00
2015-12-03 22:43:26 +00:00
2016-06-30 19:56:14 +00:00
2016-06-20 21:36:05 -04:00
2016-06-20 21:36:05 -04:00

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.