History

Jenkins 10a7974b3a Merge "Change v2.1 API status to CURRENT"		2015-02-24 08:37:02 +00:00
..
NMN	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
OS-DCF	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
OS-EXT-AZ	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
OS-EXT-IMG-SIZE	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
OS-EXT-IPS	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
OS-EXT-IPS-MAC	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
OS-EXT-SRV-ATTR	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
OS-EXT-STS	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
OS-EXT-VIF-NET	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
OS-FLV-DISABLED	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
OS-FLV-EXT-DATA	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
OS-SCH-HNT	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
OS-SRV-USG	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
all_extensions	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-admin-actions	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-agents	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-aggregates	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-assisted-volume-snapshots	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-attach-interfaces	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-availability-zone	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-baremetal-nodes	Implement api samples test for os-baremetal-nodes Part 2	2015-02-11 14:48:53 +10:30
os-block-device-mapping-v2-boot	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-cell-capacities	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-cells	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-certificates	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-cloudpipe	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-cloudpipe-update	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-config-drive	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-console-auth-tokens	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-console-output	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-consoles	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-deferred-delete	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-evacuate	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-extended-evacuate-find-host	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-extended-floating-ips	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-extended-hypervisors	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-extended-networks	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-extended-quotas	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-extended-rescue-with-image	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-extended-services-delete	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-extended-volumes	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-fixed-ips	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-flavor-access	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-flavor-extra-specs	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-flavor-manage	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-flavor-rxtx	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-flavor-swap	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-floating-ip-dns	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-floating-ip-pools	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-floating-ips	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-floating-ips-bulk	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-fping	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-hide-server-addresses	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-hosts	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-hypervisor-status	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-hypervisors	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-instance-actions	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-instance_usage_audit_log	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-keypairs	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-migrations	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-multiple-create	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-networks	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-networks-associate	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-preserve-ephemeral-rebuild	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-quota-class-sets	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-quota-sets	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-rescue	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-security-group-default-rules	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-security-groups	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-server-diagnostics	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-server-external-events	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-server-group-quotas	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-server-groups	Fix an indentation in server group api samples template	2015-01-29 13:14:24 +08:00
os-server-list-multi-status	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-server-password	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-server-sort-keys	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-server-start-stop	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-services	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-shelve	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-simple-tenant-usage	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-tenant-networks	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-used-limits	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-used-limits-for-admin	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-user-data	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-user-quotas	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-virtual-interfaces	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-volume-attachment-update	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
os-volumes	Nuke XML support from Nova REST API - Phase 1	2015-01-05 12:46:04 -05:00
README.rst	Merge "Cleanup XML for api samples tests for Nova REST API"	2015-01-27 02:50:31 +00:00
flavor-get-resp.json.tpl	move the integrated tests into the functional tree	2014-11-26 13:17:20 -05:00
flavors-list-resp.json.tpl	move the integrated tests into the functional tree	2014-11-26 13:17:20 -05:00
image-get-resp.json.tpl	move the integrated tests into the functional tree	2014-11-26 13:17:20 -05:00
image-meta-key-get.json.tpl	move the integrated tests into the functional tree	2014-11-26 13:17:20 -05:00
image-meta-key-put-req.json.tpl	move the integrated tests into the functional tree	2014-11-26 13:17:20 -05:00
image-meta-key-put-resp.json.tpl	move the integrated tests into the functional tree	2014-11-26 13:17:20 -05:00
image-metadata-get-resp.json.tpl	move the integrated tests into the functional tree	2014-11-26 13:17:20 -05:00
image-metadata-post-req.json.tpl	move the integrated tests into the functional tree	2014-11-26 13:17:20 -05:00
image-metadata-post-resp.json.tpl	move the integrated tests into the functional tree	2014-11-26 13:17:20 -05:00
image-metadata-put-req.json.tpl	move the integrated tests into the functional tree	2014-11-26 13:17:20 -05:00
image-metadata-put-resp.json.tpl	move the integrated tests into the functional tree	2014-11-26 13:17:20 -05:00
image-metadata-resp.json.tpl	move the integrated tests into the functional tree	2014-11-26 13:17:20 -05:00
images-details-get-resp.json.tpl	move the integrated tests into the functional tree	2014-11-26 13:17:20 -05:00
images-details-resp.json.tpl	move the integrated tests into the functional tree	2014-11-26 13:17:20 -05:00
images-list-get-resp.json.tpl	move the integrated tests into the functional tree	2014-11-26 13:17:20 -05:00
images-list-resp.json.tpl	move the integrated tests into the functional tree	2014-11-26 13:17:20 -05:00
limit-get-resp.json.tpl	move the integrated tests into the functional tree	2014-11-26 13:17:20 -05:00
server-action-changepassword.json.tpl	move the integrated tests into the functional tree	2014-11-26 13:17:20 -05:00
server-action-confirmresize.json.tpl	move the integrated tests into the functional tree	2014-11-26 13:17:20 -05:00
server-action-createimage.json.tpl	move the integrated tests into the functional tree	2014-11-26 13:17:20 -05:00
server-action-reboot.json.tpl	move the integrated tests into the functional tree	2014-11-26 13:17:20 -05:00
server-action-rebuild-resp.json.tpl	move the integrated tests into the functional tree	2014-11-26 13:17:20 -05:00
server-action-rebuild.json.tpl	move the integrated tests into the functional tree	2014-11-26 13:17:20 -05:00
server-action-resize.json.tpl	move the integrated tests into the functional tree	2014-11-26 13:17:20 -05:00
server-action-revertresize.json.tpl	move the integrated tests into the functional tree	2014-11-26 13:17:20 -05:00
server-get-resp.json.tpl	move the integrated tests into the functional tree	2014-11-26 13:17:20 -05:00
server-ips-network-resp.json.tpl	move the integrated tests into the functional tree	2014-11-26 13:17:20 -05:00
server-ips-resp.json.tpl	move the integrated tests into the functional tree	2014-11-26 13:17:20 -05:00
server-metadata-all-req.json.tpl	move the integrated tests into the functional tree	2014-11-26 13:17:20 -05:00
server-metadata-all-resp.json.tpl	move the integrated tests into the functional tree	2014-11-26 13:17:20 -05:00
server-metadata-req.json.tpl	move the integrated tests into the functional tree	2014-11-26 13:17:20 -05:00
server-metadata-resp.json.tpl	move the integrated tests into the functional tree	2014-11-26 13:17:20 -05:00
server-post-req.json.tpl	move the integrated tests into the functional tree	2014-11-26 13:17:20 -05:00
server-post-resp.json.tpl	move the integrated tests into the functional tree	2014-11-26 13:17:20 -05:00
servers-details-resp.json.tpl	move the integrated tests into the functional tree	2014-11-26 13:17:20 -05:00
servers-list-resp.json.tpl	move the integrated tests into the functional tree	2014-11-26 13:17:20 -05:00
versions-get-resp.json.tpl	Change v2.1 API status to CURRENT	2015-02-09 05:27:56 +00: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. There should be both JSON and XML tests included.

Then run the following command:

GENERATE_SAMPLES=True tox -e functional

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.