d2f3f8ccd9
This adds API docs for a new endpoint created to check the actions of a stack update without actually doing anything. Related Heat change: https://review.openstack.org/#/c/122473/ Co-Authored-By: Jason Dunsmore <jasondunsmore@gmail.com> Change-Id: I2ef30b9108a106045ec0ef1e380e47803659fda5 BP: update-dry-run
213 lines
9.9 KiB
XML
213 lines
9.9 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<chapter xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:xi="http://www.w3.org/2001/XInclude"
|
|
xmlns:xlink="http://www.w3.org/1999/xlink"
|
|
xmlns:linkend="http://www.w3.org/1999/linkend"
|
|
xmlns:xref="http://www.w3.org/1999/xref"
|
|
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
|
version="5.0-extension RackBook-2.0" xml:id="orchestration-v1"
|
|
role="api-reference">
|
|
<title>Orchestration API v1 (CURRENT)</title>
|
|
<para>Uses a template language to orchestrate OpenStack
|
|
services.</para>
|
|
<section xml:id="general-info">
|
|
<title>General API information</title>
|
|
<para>Authenticated calls that target a known URI but that use an
|
|
HTTP method that the implementation does not support return a <code>405
|
|
Method Not Allowed</code> error code. In addition, the HTTP
|
|
<code>OPTIONS</code> method is supported for each known URI. In
|
|
both cases, the <code>Allow</code> response header indicates the
|
|
HTTP methods that are supported for the resource.</para>
|
|
</section>
|
|
<section xml:id="heat-versions">
|
|
<title>API versions</title>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/orchestration-api/src/v1/orchestration-api.wadl#versions">
|
|
<wadl:method href="#getVersions-heat-v1"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
<section xml:id="stacks">
|
|
<title>Stacks</title>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/orchestration-api/src/v1/orchestration-api.wadl#stacks">
|
|
<wadl:method href="#stack_create"/>
|
|
<wadl:method href="#stack_adopt"/>
|
|
<wadl:method href="#stack_list"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/orchestration-api/src/v1/orchestration-api.wadl#preview">
|
|
<wadl:method href="#stack_preview"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/orchestration-api/src/v1/orchestration-api.wadl#update_preview">
|
|
<wadl:method href="#stack_update_preview"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/orchestration-api/src/v1/orchestration-api.wadl#stack_name">
|
|
<wadl:method href="#stack_find"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/orchestration-api/src/v1/orchestration-api.wadl#resources">
|
|
<wadl:method href="#stack_resources_find"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/orchestration-api/src/v1/orchestration-api.wadl#stack_id">
|
|
<wadl:method href="#stack_show"/>
|
|
<wadl:method href="#stack_update"/>
|
|
<wadl:method href="#stack_delete"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/orchestration-api/src/v1/orchestration-api.wadl#abandon">
|
|
<wadl:method href="#stack_abandon"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/orchestration-api/src/v1/orchestration-api.wadl#snapshots">
|
|
<wadl:method href="#stack_snapshot"/>
|
|
<wadl:method href="#stack_list_snapshot"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/orchestration-api/src/v1/orchestration-api.wadl#snapshot_id_snapshots">
|
|
<wadl:method href="#stack_show_snapshot"/>
|
|
<wadl:method href="#stack_delete_snapshot"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/orchestration-api/src/v1/orchestration-api.wadl#restore">
|
|
<wadl:method href="#stack_restore_snapshot"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
<section xml:id="stack-actions">
|
|
<title>Stack actions</title>
|
|
<para>Performs non-lifecycle operations on the stack. Specify
|
|
the action in the request body.</para>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/orchestration-api/src/v1/orchestration-api.wadl#actions">
|
|
<wadl:method href="#stack_action_suspend"/>
|
|
<wadl:method href="#stack_action_resume"/>
|
|
<wadl:method href="#stack_action_cancel_update"/>
|
|
<wadl:method href="#stack_action_check"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
<section xml:id="stack-resources">
|
|
<title>Stack resources</title>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/orchestration-api/src/v1/orchestration-api.wadl#resources2">
|
|
<wadl:method href="#resource_list"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/orchestration-api/src/v1/orchestration-api.wadl#resource_name">
|
|
<wadl:method href="#resource_show"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/orchestration-api/src/v1/orchestration-api.wadl#metadata">
|
|
<wadl:method href="#resource_metadata"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/orchestration-api/src/v1/orchestration-api.wadl#signal">
|
|
<wadl:method href="#resource_signal"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
<section xml:id="stack-events">
|
|
<title>Stack events</title>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/orchestration-api/src/v1/orchestration-api.wadl#events">
|
|
<wadl:method href="#stack_events_find"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/orchestration-api/src/v1/orchestration-api.wadl#events2">
|
|
<wadl:method href="#stack_event_list"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/orchestration-api/src/v1/orchestration-api.wadl#events4">
|
|
<wadl:method href="#resource_event_list"
|
|
/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/orchestration-api/src/v1/orchestration-api.wadl#event_id">
|
|
<wadl:method href="#event_show"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
<section xml:id="stack-templates">
|
|
<title>Templates</title>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/orchestration-api/src/v1/orchestration-api.wadl#template">
|
|
<wadl:method href="#stack_template"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/orchestration-api/src/v1/orchestration-api.wadl#list_template_versions">
|
|
<wadl:method href="#template_version_list"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/orchestration-api/src/v1/orchestration-api.wadl#validate_template">
|
|
<wadl:method href="#template_validate"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/orchestration-api/src/v1/orchestration-api.wadl#resource_template">
|
|
<wadl:method href="#resource_type_template"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/orchestration-api/src/v1/orchestration-api.wadl#resource_types">
|
|
<wadl:method href="#resource_type_get"/>
|
|
<wadl:method href="#resource_type_list"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
<section xml:id="build-info">
|
|
<title>Build info</title>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/orchestration-api/src/v1/orchestration-api.wadl#build_info">
|
|
<wadl:method href="#build_info_show"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
<section xml:id="software-config">
|
|
<title>Software configuration</title>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/orchestration-api/src/v1/orchestration-api.wadl#software_configs">
|
|
<wadl:method href="#software_config_create"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/orchestration-api/src/v1/orchestration-api.wadl#config_id">
|
|
<wadl:method href="#software_config_show"/>
|
|
<wadl:method href="#software_config_delete"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/orchestration-api/src/v1/orchestration-api.wadl#software_deployments">
|
|
<wadl:method href="#software_deployment_index"/>
|
|
<wadl:method href="#software_deployment_create"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/orchestration-api/src/v1/orchestration-api.wadl#server_id">
|
|
<wadl:method href="#software_deployment_metadata"/>
|
|
</wadl:resource>
|
|
<wadl:resource
|
|
href="../wadls/orchestration-api/src/v1/orchestration-api.wadl#deployment_id">
|
|
<wadl:method href="#software_deployment_show"/>
|
|
<wadl:method href="#software_deployment_update"/>
|
|
<wadl:method href="#software_deployment_delete"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
<section xml:id="service-status">
|
|
<title>Manage service</title>
|
|
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
|
<wadl:resource
|
|
href="../wadls/orchestration-api/src/v1/orchestration-api.wadl#service_list">
|
|
<wadl:method href="#service_status_list"/>
|
|
</wadl:resource>
|
|
</wadl:resources>
|
|
</section>
|
|
</chapter>
|