summaryrefslogtreecommitdiff
path: root/api-ref/source/v1/stack-templates.inc
blob: e9b735871a467468900148d887c0ca9d749e2266 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
.. -*- rst -*-

=========
Templates
=========

List template versions
======================

.. rest_method::  GET /v1/{tenant_id}/template_versions

Lists all available template versions.

Response Codes
--------------

.. rest_status_code:: success status.yaml

   - 200

.. rest_status_code:: error status.yaml

   - 400
   - 401
   - 404
   - 500

Request Parameters
------------------

.. rest_parameters:: parameters.yaml

   - tenant_id: tenant_id

Response Parameters
-------------------

.. rest_parameters:: parameters.yaml

   - X-Openstack-Request_id: request_id
   - template_versions: template_versions
   - alias: template_version_alias
   - type: template_type
   - version: template_version


Response Example
----------------

.. literalinclude:: samples/template-versions-response.json
   :language: javascript


List template functions
=======================

.. rest_method::  GET /v1/{tenant_id}/template_versions/{template_version}/functions

Lists all available functions for a template version.

Response Codes
--------------

.. rest_status_code:: success status.yaml

   - 200

.. rest_status_code:: error status.yaml

   - 400
   - 401
   - 404
   - 500

Request Parameters
------------------

.. rest_parameters:: parameters.yaml

   - tenant_id: tenant_id
   - template_version: template_version_url

Response Parameters
-------------------

.. rest_parameters:: parameters.yaml

   - X-Openstack-Request-Id: request_id
   - template_functions: template_functions
   - description: function_description
   - functions: functions

Response Example
----------------

.. literalinclude:: samples/template-functions-list-response.json
   :language: javascript


Validate template
=================

.. rest_method::  POST /v1/{tenant_id}/validate

Validates a template.

Response Codes
--------------

.. rest_status_code:: success status.yaml

   - 200

.. rest_status_code:: error status.yaml

   - 400
   - 500

Request Parameters
------------------

.. rest_parameters:: parameters.yaml

   - tenant_id: tenant_id
   - environment: environment
   - environment_files: environment_files
   - files: files
   - ignore_errors: ignore_errors
   - show_nested: show_nested
   - template: template
   - template_url: template_url

Request Example
---------------

.. literalinclude:: samples/template-validate-request.json
   :language: javascript

Response Parameters
-------------------

.. rest_parameters:: parameters.yaml

   - X-Openstack-Request-Id: request_id
   - Description: Description
   - ParameterGroups: ParameterGroups
   - Parameters: Parameters

Response Example
----------------

.. literalinclude:: samples/template-validate-response.json
   :language: javascript