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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
|
.. -*- rst -*-
Metadata definition tags
************************
Creates, lists, shows details for, updates, and deletes metadata
definition tags.
*Since API v2.2*
Create tag definition
~~~~~~~~~~~~~~~~~~~~~
.. rest_method::
POST /v2/metadefs/namespaces/{namespace_name}/tags/{tag_name}
Adds a tag to the list of namespace tag definitions.
Normal response codes: 201
Error response codes: 400, 401, 403, 404, 409
Request
-------
.. rest_parameters:: metadefs-parameters.yaml
- namespace_name: namespace_name
- tag_name: tag_name
There is no request body.
Response Parameters
-------------------
.. rest_parameters:: metadefs-parameters.yaml
- created_at: created_at
- name: name-tag
- updated_at: updated_at
Response Example
----------------
.. literalinclude:: samples/metadef-tag-create-response.json
:language: json
Get tag definition
~~~~~~~~~~~~~~~~~~
.. rest_method::
GET /v2/metadefs/namespaces/{namespace_name}/tags/{tag_name}
Gets a definition for a tag.
The response body shows a single tag entity.
Normal response codes: 200
Error response codes: 400, 401, 403, 404
Request
-------
.. rest_parameters:: metadefs-parameters.yaml
- tag_name: tag_name
- namespace_name: namespace_name
There is no request body.
Response Parameters
-------------------
.. rest_parameters:: metadefs-parameters.yaml
- created_at: created_at
- name: name-tag
- updated_at: updated_at
Response Example
----------------
.. literalinclude:: samples/metadef-tag-details-response.json
:language: json
Update tag definition
~~~~~~~~~~~~~~~~~~~~~
.. rest_method::
PUT /v2/metadefs/namespaces/{namespace_name}/tags/{tag_name}
Renames a tag definition.
Normal response codes: 200
Error response codes: 400, 401, 403, 404, 409
Request
-------
.. rest_parameters:: metadefs-parameters.yaml
- tag_name: tag_name
- namespace_name: namespace_name
- name: name-tag
Request Example
---------------
.. literalinclude:: samples/metadef-tag-update-request.json
:language: json
Response Parameters
-------------------
.. rest_parameters:: metadefs-parameters.yaml
- created_at: created_at
- name: name-tag
- updated_at: updated_at
Response Example
----------------
.. literalinclude:: samples/metadef-tag-update-response.json
:language: json
Delete tag definition
~~~~~~~~~~~~~~~~~~~~~
.. rest_method::
DELETE /v2/metadefs/namespaces/{namespace_name}/tags/{tag_name}
Deletes a tag definition within a namespace.
.. note::
If the namespace containing the tag is protected, that is, if the
``protected`` attribute of the namespace is ``true``, then you must first
set the ``protected`` attribute to ``false`` on the namespace before you
will be permitted to delete the tag.
* If you try to delete a tag from a protected namespace, the call returns
the ``403`` response code.
* To change the ``protected`` attribute of a namespace, use the
:ref:`Update namespace <v2-update-namespace>` call.
When you successfully delete a tag from a namespace, the response is empty and
the response code is ``204``.
Normal response codes: 204
Error response codes: 400, 401, 403, 404
Request
-------
.. rest_parameters:: metadefs-parameters.yaml
- namespace_name: namespace_name
- tag_name: tag_name
Create tags
~~~~~~~~~~~
.. rest_method:: POST /v2/metadefs/namespaces/{namespace_name}/tags
Creates one or more tag definitions in a namespace.
Normal response codes: 201
Error response codes: 400, 401, 403, 404, 409
Request
-------
.. rest_parameters:: metadefs-parameters.yaml
- X-Openstack-Append: append
- namespace_name: namespace_name
- tags: tags
Request Example
---------------
.. literalinclude:: samples/metadef-tags-create-request.json
:language: json
Response Parameters
-------------------
.. rest_parameters:: metadefs-parameters.yaml
- name: name
- tags: tags
Response Example
----------------
.. literalinclude:: samples/metadef-tag-create-response.json
:language: json
List tags
~~~~~~~~~
.. rest_method::
GET /v2/metadefs/namespaces/{namespace_name}/tags
Lists the tag definitions within a namespace.
To manually paginate through the list of tags, use the ``limit``
and ``marker`` parameters.
To sort the results of this operation use the ``sort_key`` and
``sort_dir`` parameters. The API uses the natural sort order of the
tag attribute of the ``sort_key`` parameter.
Normal response codes: 200
Error response codes: 401, 403, 404
Request
-------
.. rest_parameters:: metadefs-parameters.yaml
- namespace_name: namespace_name
- limit: limit-tags
- marker: marker-tags
- sort_key: sort_key-tags
- sort_dir: sort_dir
There is no request body.
Response Parameters
-------------------
.. rest_parameters:: metadefs-parameters.yaml
- tags: tags
Response Example
----------------
.. literalinclude:: samples/metadef-tags-list-response.json
:language: json
Delete all tag definitions
~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method::
DELETE /v2/metadefs/namespaces/{namespace_name}/tags
Deletes all tag definitions within a namespace.
.. note::
If the namespace containing the tags is protected, that is, if the
``protected`` attribute of the namespace is ``true``, then you must first
set the ``protected`` attribute to ``false`` on the namespace before you
will be permitted to delete the tags. If you try to delete the tags
from a protected namespace, the call returns the ``403`` response code.
When you successfully delete the tags from a namespace, the
response is empty and the response code is ``204``.
Normal response codes: 204
Error response codes: 403, 404
Request
-------
.. rest_parameters:: metadefs-parameters.yaml
- namespace_name: namespace_name
There is no request body.
There is no response body.
|
