1.. -*- rst -*-
2
3Group type specs
4================
5
6Create or update group specs for a group type
7~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8
9.. rest_method::  POST /v3/{project_id}/group_types/{group_type_id}/group_specs
10
11Create group specs for a group type, if the specification key already exists in group specs,
12this API will update the specification as well.
13
14
15Normal response codes: 202
16
17Error response codes: badRequest(400), forbidden(403), itemNotFound(404)
18
19
20Request
21-------
22
23.. rest_parameters:: parameters.yaml
24
25   - project_id: project_id_path
26   - group_type_id: group_type_id_1
27   - group_specs: group_specs_2
28
29Request Example
30---------------
31
32.. literalinclude:: ./samples/group-type-specs-create-request.json
33   :language: javascript
34
35
36
37Response Parameters
38-------------------
39
40.. rest_parameters:: parameters.yaml
41
42   - group_specs: group_specs_2
43
44
45Response Example
46----------------
47
48.. literalinclude:: ./samples/group-type-specs-create-response.json
49   :language: javascript
50
51
52List group specs for a group type
53~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
54
55.. rest_method::  GET /v3/{project_id}/group_types/{group_type_id}/group_specs
56
57List all the group specs for a group type,
58
59
60Normal response codes: 200
61
62Error response codes: itemNotFound(404), forbidden(403)
63
64
65Request
66-------
67
68.. rest_parameters:: parameters.yaml
69
70   - project_id: project_id_path
71   - group_type_id: group_type_id_1
72
73
74Response Parameters
75-------------------
76
77.. rest_parameters:: parameters.yaml
78
79   - group_specs: group_specs_2
80
81
82Response Example
83----------------
84
85.. literalinclude:: ./samples/group-type-specs-list-response.json
86   :language: javascript
87
88
89Show one specific group spec for a group type
90~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
91
92.. rest_method::  GET /v3/{project_id}/group_types/{group_type_id}/group_specs/{spec_id}
93
94Show a group spec for a group type,
95
96
97Normal response codes: 200
98
99Error response codes: itemNotFound(404), forbidden(403)
100
101
102Request
103-------
104
105.. rest_parameters:: parameters.yaml
106
107   - project_id: project_id_path
108   - group_type_id: group_type_id_1
109   - spec_id: spec_id
110
111
112Response Parameters
113-------------------
114
115.. rest_parameters:: parameters.yaml
116
117   - spec: spec_value
118
119Response Example
120----------------
121
122.. literalinclude:: ./samples/group-type-specs-show-response.json
123   :language: javascript
124
125
126Update one specific group spec for a group type
127~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
128
129.. rest_method::  PUT /v3/{project_id}/group_types/{group_type_id}/group_specs/{spec_id}
130
131Update a group spec for a group type,
132
133
134Normal response codes: 200
135
136Error response codes: itemNotFound(404), forbidden(403)
137
138
139Request
140-------
141
142.. rest_parameters:: parameters.yaml
143
144   - project_id: project_id_path
145   - group_type_id: group_type_id_1
146   - spec_id: spec_id
147   - spec: spec_value
148
149Request Example
150---------------
151
152.. literalinclude:: ./samples/group-type-specs-update-request.json
153   :language: javascript
154
155Response Parameters
156-------------------
157
158.. rest_parameters:: parameters.yaml
159
160   - spec: spec_value
161
162Response Example
163----------------
164
165.. literalinclude:: ./samples/group-type-specs-update-response.json
166   :language: javascript
167
168
169Delete one specific group spec for a group type
170~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
171
172.. rest_method::  DELETE /v3/{project_id}/group_types/{group_type_id}/group_specs/{spec_id}
173
174Delete a group spec for a group type,
175
176
177Normal response codes: 202
178
179Error response codes: itemNotFound(404), forbidden(403)
180
181
182Request
183-------
184
185.. rest_parameters:: parameters.yaml
186
187   - project_id: project_id_path
188   - group_type_id: group_type_id_1
189   - spec_id: spec_id
190