NSDescriptorManagement_resp.yaml 11 KB
Newer Older
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
 responses:
   202-with-Location:
     description: > 
       Accepted
       
       The request was accepted for processing, but the processing has not 
       been completed. The response body shall be empty.
       The HTTP response shall include a "Location" HTTP
       header that contains the URI of the newly-created
       "NS lifecycle operation occurrence" resource
       corresponding to the operation.
     headers:
       Content-Type:
         description: The MIME type of the body of the response.
         type: string
         maximum: 1
         minimum: 1
       Location:
         description: The resource URI of the created NS instance
         type: string
         format: url
       WWW-Authenticate:
         description: >
           Challenge if the corresponding HTTP request has not provided
           authorization, or error details if the corresponding HTTP
           request has provided an invalid authorization token.
         type: string
         maximum: 1
         minimum: 0
     schema:
       $ref: "../definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsInstance"
   202-with-Location-empty:
     description: > 
       Accepted
 
       The request was accepted for processing, but the processing has not
       been completed. On success, the HTTP response shall include a
       "Location" HTTP header that contains the URI of the newly-created
       "NS Descriptor operation occurrence" resource corresponding to the
       operation.
       The response body shall be empty.
     headers:
       Location:
         description: The resource URI of the created NS instance
         type: string
         format: url
       WWW-Authenticate:
         description: >
           Challenge if the corresponding HTTP request has not provided
           authorization, or error details if the corresponding HTTP
           request has provided an invalid authorization token.
         type: string
         maximum: 1
         minimum: 0
   409:
     description: >
       Conflict
 
59
       Error: The operation cannot be executed currently,
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
       due to a conflict with the state of the resource.
       Typically, this is due to the fact the NS descriptor
       resource is in the enabled operational state (i.e.
       operationalState = ENABLED) or there are running
       NS instances using the concerned individual NS
       descriptor resource (i.e. usageState = IN_USE).
       The response body shall contain a ProblemDetails
       structure, in which the "detail" attribute shall convey
       more information about the error.
     headers:
       Content-Type:
         description: The MIME type of the body of the response.
         type: string
         maximum: 1
         minimum: 1
       WWW-Authenticate:
         description: >
           Challenge if the corresponding HTTP request has not provided
           authorization, or error details if the corresponding HTTP
           request has provided an invalid authorization token.
         type: string
         maximum: 1
         minimum: 0
     schema:
       $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
   409-another-nsd-operation-ongoing:
     description: >
       Conflict
 
       The operation cannot be executed currently, due to a conflict with the
       state of the NS instance resource.
       Typically, this is due to the fact that another Descriptor operation is
       ongoing.
       The response body shall contain a ProblemDetails structure, in which the
       "detail" attribute should convey more information about the error.
     headers:
       Content-Type:
         description: The MIME type of the body of the response.
         type: string
         maximum: 1
         minimum: 1
       WWW-Authenticate:
         description: >
           Challenge if the corresponding HTTP request has not provided
           authorization, or error details if the corresponding HTTP
           request has provided an invalid authorization token.
         type: string
         maximum: 1
         minimum: 0
     schema:
       $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
   409-inconsistent-state:
     description: >
       Conflict
 
115
       Another request is in progress that prohibits the fulfillment of
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
       the current request, or the current resource state is inconsistent
       with the request.
     headers:
       Content-Type:
         description: The MIME type of the body of the response.
         type: string
         maximum: 1
         minimum: 1
       WWW-Authenticate:
         description: >
           Challenge if the corresponding HTTP request has not provided
           authorization, or error details if the corresponding HTTP
           request has provided an invalid authorization token.
         type: string
         maximum: 1
         minimum: 0
     schema:
       $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
   409-state-conflict-INSTANTIATED:
     description: >
       Conflict
 
       The operation cannot be executed currently, due to a conflict with the
       state of the NS instance resource.
       Typically, this is due to the fact that the NS instance resource is in
       INSTANTIATED state.
       The response body shall contain a ProblemDetails structure, in which the
       "detail" attribute should convey more information about the error.
     headers:
       Content-Type:
         description: The MIME type of the body of the response.
         type: string
         maximum: 1
         minimum: 1
       WWW-Authenticate:
         description: >
           Challenge if the corresponding HTTP request has not provided
           authorization, or error details if the corresponding HTTP
           request has provided an invalid authorization token.
         type: string
         maximum: 1
         minimum: 0
     schema:
       $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
   409-state-conflict-not-FAILED_TEMP:
     description: >
       The operation cannot be executed currently, due to a conflict with the
       state of the NS instance resource.
       Typically, this is due to the fact that the NS instance resource is
       not in FAILED_TEMP state, or another error handling action is starting,
       such as rollback or fail.
       The response body shall contain a ProblemDetails structure, in which the
       "detail" attribute should convey more information about the error.
     headers:
       Content-Type:
         description: The MIME type of the body of the response.
         type: string
         maximum: 1
         minimum: 1
       WWW-Authenticate:
         description: >
           Challenge if the corresponding HTTP request has not provided
           authorization, or error details if the corresponding HTTP
           request has provided an invalid authorization token.
         type: string
         maximum: 1
         minimum: 0
     schema:
       $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
   409-state-conflict-NOT-INSTANTIATED:
     description: >
       Conflict
 
       The operation cannot be executed currently, due to a conflict with the
       state of the NS instance resource.
       Typically, this is due to the fact that the NS instance resource is in
       NOT-INSTANTIATED state, or that another lifecycle management operation
       is ongoing.
       The response body shall contain a ProblemDetails structure, in which the
       "detail" attribute should convey more information about the error.
     headers:
       Content-Type:
         description: The MIME type of the body of the response.
         type: string
         maximum: 1
         minimum: 1
       WWW-Authenticate:
         description: >
           Challenge if the corresponding HTTP request has not provided
           authorization, or error details if the corresponding HTTP
           request has provided an invalid authorization token.
         type: string
         maximum: 1
         minimum: 0
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
     schema:
       $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"       
   409-nsd-onboarding-state-NOT-ONBOARDED:
     description: >
       Conflict
 
       Error: The operation cannot be executed currently,
       due to a conflict with the state of the resource.
       Typically, this is due to the fact "nsdOnboardingState"
       has a value different from ONBOARDED.
       The response body shall contain a ProblemDetails
       structure, in which the "detail" attribute shall convey
       more information about the error.
     headers:
       Content-Type:
         description: The MIME type of the body of the response.
         type: string
         maximum: 1
         minimum: 1
       WWW-Authenticate:
         description: >
           Challenge if the corresponding HTTP request has not provided
           authorization, or error details if the corresponding HTTP
           request has provided an invalid authorization token.
         type: string
         maximum: 1
         minimum: 0
     schema:
       $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
   409-pnfd-onboarding-state-NOT-ONBOARDED:
     description: >
       Conflict
 
       Error: The operation cannot be executed currently,
       due to a conflict with the state of the resource.
       Typically, this is due to the fact pnfdOnboardingState
       has a value different from ONBOARDED.
       The response body shall contain a ProblemDetails
       structure, in which the "detail" attribute shall convey
       more information about the error.
     headers:
       Content-Type:
         description: The MIME type of the body of the response.
         type: string
         maximum: 1
         minimum: 1
       WWW-Authenticate:
         description: >
           Challenge if the corresponding HTTP request has not provided
           authorization, or error details if the corresponding HTTP
           request has provided an invalid authorization token.
         type: string
         maximum: 1
         minimum: 0
     schema:
       $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
   409-pnfd-onboarding-state-NOT-CREATED:
     description: >
       Conflict.
 
       Error: The operation cannot be executed currently,
       due to a conflict with the state of the resource.
       Typically, this is due to the fact that the
       PnfdOnboardingState has a value other than CREATED.
       The response body shall contain a ProblemDetails
       structure, in which the "detail" attribute shall convey
       more information about the error.
     headers:
       Content-Type:
         description: The MIME type of the body of the response.
         type: string
         maximum: 1
         minimum: 1
       WWW-Authenticate:
         description: >
           Challenge if the corresponding HTTP request has not provided
           authorization, or error details if the corresponding HTTP
           request has provided an invalid authorization token.
         type: string
         maximum: 1
         minimum: 0
291
292
     schema:
       $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails"