VNFLifecycleManagement_resp.yaml 6.62 KB
Newer Older
1
2
# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt
3

4
5
6
responses:
  202-with-Location:
    description: > 
Gergely Csatari's avatar
Gergely Csatari committed
7
8
      Accepted

9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
      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
      "VNF LCM 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 VNF 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
32
33
34
35
36
      Version:
        description: The used API version.
        type: string
        maximum: 1
        minimum: 1
37
38
39
40
    schema:
      $ref: "../definitions/VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
  409-another-lcm-operation-ongoing:
    description: >
Gergely Csatari's avatar
Gergely Csatari committed
41
42
      Conflict

43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
      The operation cannot be executed currently, due to a conflict with the
      state of the VNF instance resource.
      Typically, this is due to the fact that another LCM 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
63
64
65
66
67
      Version:
        description: The used API version.
        type: string
        maximum: 1
        minimum: 1
68
69
70
71
    schema:
      $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
  409-inconsistent-state:
    description: >
Gergely Csatari's avatar
Gergely Csatari committed
72
73
      Conflict

74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
      Another request is in progress that prohibits the fulfilment of
      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
91
92
93
94
95
      Version:
        description: The used API version.
        type: string
        maximum: 1
        minimum: 1
96
97
98
99
    schema:
      $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
  409-state-conflict-INSTANTIATED:
    description: >
Gergely Csatari's avatar
Gergely Csatari committed
100
101
      Conflict

102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
      The operation cannot be executed currently, due to a conflict with the
      state of the VNF instance resource.
      Typically, this is due to the fact that the VNF 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
122
123
124
125
126
      Version:
        description: The used API version.
        type: string
        maximum: 1
        minimum: 1
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
    schema:
      $ref: "../../../definitions/SOL002SOL003_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 VNF instance resource.
      Typically, this is due to the fact that the VNF 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
152
153
154
155
156
      Version:
        description: The used API version.
        type: string
        maximum: 1
        minimum: 1
157
158
159
160
    schema:
      $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
  409-state-conflict-NOT-INSTANTIATED:
    description: >
Gergely Csatari's avatar
Gergely Csatari committed
161
162
      Conflict

163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
      The operation cannot be executed currently, due to a conflict with the
      state of the VNF instance resource.
      Typically, this is due to the fact that the VNF 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
184
185
186
187
188
      Version:
        description: The used API version.
        type: string
        maximum: 1
        minimum: 1
189
190
    schema:
      $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"