Difference between revisions of "Heat/Blueprints/V2API"

Revision as of 10:19, 28 November 2013

Area to start documenting changes required for a Heat v2 API:

Remove tenant ID from the endpoint path
Remove references to tenant in the request body (we can derive it from the context)
Remove template_url from the request POST (always load the template in the client, like we do for provider templates?)
Pass parameters as dict/json?

Draft Spec [WORKINPROGRESS]

POST v2/stacks
Create a stack

stack_name: The name of the stack to create.

template: A JSON template to instantiate.

environment: A JSON envionment for the stack.

files: A map of file names (Provider resource templates, as referenced in the environment) to JSON template bodies.

parameters: A JSON map of parameter values

timeout_mins: The timeout for stack creation in minutes.

GET v2/stacks
Get a list of active stacks.

Allow getting a stack by name via filter parameters, e.g

:GET v2/stacks?name=foo

ref https://review.openstack.org/#/c/57313/

GET v2/stacks/{stack_id}
Find the canonical URL for a stack with a given name.

GET v2/stacks/resources
Find the canonical URL for the resource list of a stack with a given name.

GET v2/stacks/events
Find the canonical URL for the event list of a stack with a given name.

GET v2/stacks/{stack_id}
Get data about a stack.

PUT v2/stacks/{stack_id}
Update a stack.

DELETE v2/stacks/{stack_id}
Delete a stack.

GET v2/stacks/{stack_id}/events
Get a list of events for a stack.

GET v2/stacks/{stack_id}/resources
Get a list of resources in a stack.

GET v2/stacks/{stack_id}/resources/{resource_name}
Get data about a resource.

GET v2/stacks/{stack_id}/resources/{resource_name}/metadata
Get a resource's metadata.

GET v2/stacks/{stack_id}/resources/events
Get a list of events for a stack resource.

GET v2/stacks/{stack_id}/resources/events/{event_id}
Get data about an event.

GET v2/stacks/{stack_id}/template
Retrieve a stack's template.

POST v2/validate_template
Validate a template.

GET v2/resource_types
Get a list of the template resource types that are supported.

@@ Line 17: / Line 17: @@
 :timeout_mins: The timeout for stack creation in minutes.<br />
-GET v2/stacks<br />
+'''GET v2/stacks<br />'''
 Get a list of active stacks.
-- Allow getting a stack by name via filter parameters, e.g
+:Allow getting a stack by name via filter parameters, e.g
-  (ref https://review.openstack.org/#/c/57313/)
+''':GET v2/stacks?name=foo'''
-GET v2/stacks?name=foo
+:ref https://review.openstack.org/#/c/57313/
-GET v2/stacks/{stack_id}<br />
+'''GET v2/stacks/{stack_id}<br />'''
 Find the canonical URL for a stack with a given name.
-GET v2/stacks/resources<br />
+'''GET v2/stacks/resources<br />'''
 Find the canonical URL for the resource list of a stack with a given name.
-GET v2/stacks/events<br />
+'''GET v2/stacks/events<br />'''
 Find the canonical URL for the event list of a stack with a given name.
-GET v2/stacks/{stack_id}<br />
+'''GET v2/stacks/{stack_id}<br />'''
 Get data about a stack.
-PUT v2/stacks/{stack_id}<br />
+'''PUT v2/stacks/{stack_id}<br />'''
 Update a stack.
-DELETE v2/stacks/{stack_id}<br />
+'''DELETE v2/stacks/{stack_id}<br />'''
 Delete a stack.
-GET v2/stacks/{stack_id}/events<br />
+'''GET v2/stacks/{stack_id}/events<br />'''
 Get a list of events for a stack.
-GET v2/stacks/{stack_id}/resources<br />
+'''GET v2/stacks/{stack_id}/resources<br />'''
 Get a list of resources in a stack.
-GET v2/stacks/{stack_id}/resources/{resource_name}<br />
+'''GET v2/stacks/{stack_id}/resources/{resource_name}<br />'''
 Get data about a resource.
-GET v2/stacks/{stack_id}/resources/{resource_name}/metadata<br />
+'''GET v2/stacks/{stack_id}/resources/{resource_name}/metadata<br />'''
 Get a resource's metadata.
-GET v2/stacks/{stack_id}/resources/events<br />
+'''GET v2/stacks/{stack_id}/resources/events<br />'''
 Get a list of events for a stack resource.
-GET v2/stacks/{stack_id}/resources/events/{event_id}<br />
+'''GET v2/stacks/{stack_id}/resources/events/{event_id}<br />'''
 Get data about an event.
-GET v2/stacks/{stack_id}/template<br />
+'''GET v2/stacks/{stack_id}/template<br />'''
 Retrieve a stack's template.
-POST v2/validate_template<br />
+'''POST v2/validate_template<br />'''
 Validate a template.
-GET v2/resource_types<br />
+'''GET v2/resource_types<br />'''
 Get a list of the template resource types that are supported.