Newer
Older
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
WWW-Authenticate:
type: string
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.
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
Samir Medjiah
committed
# description: >
# 409 CONFLICT
# Shall be returned upon the following 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.
$ref: "../responses/SOL005_resp.yaml#/components/responses/409"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/components/responses/504"
moscatelli
committed
Samir Medjiah
committed
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
###############################################################################
# Individual NSD Archive Artifact #
###############################################################################
'/ns_descriptors/{nsdInfoId}/artifacts/{artifactPath}':
#ETSI GS NFV-SOL 005 V3.3.1 location: 5.4.4c
parameters:
- name: nsdInfoId
description: >
Identifier of the individual NS descriptor.
This identifier can be retrieved from the resource referenced by
the "Location" HTTP header in the response to a POST request creating
a new NS descriptor resource. It can also be retrieved from the "id"
attribute in the payload body of that response.
in: path
required: true
type: string
- name: artifactPath
description: >
For an artifact contained as a file in the NSD archive, this variable shall
contain a sequence of one or path segments representing the path of the
artifact within the NSD archive, relative to the root of the package.
EXAMPLE: foo/bar/m%40ster.sh
For an external artifact represented as a URI in the NSD archive manifest,
this variable shall contain the URI as provided in the NS archive.
This identifier can be retrieved from the "artifactPath" attribute of the
applicable "artifacts" entry in the body of the response to a GET request
querying the "Individual NSD" resource.
Since multiple path segments are allowed to be contained in this variable,
the "/" character that separates these segments is not percent-encoded.
Each individual segment is percent-encoded if necessary as defined in
clause 4.1 of ETSI GS NFV-SOL 013.
in: path
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235.
in: header
required: false
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
get:
description: >
The GET method fetches the content of an individual artifact within
a NSD archive.
This method shall follow the provisions specified in the Tables 5.4.4c.3.2-1
and 5.4.4c.3.2-2 for URI query parameters, request and response data structures,
and response codes.
parameters:
- name : Range
description: >
The request may contain a "Range" HTTP header to obtain single
range of bytes from an artifact file. This can be used to continue
an aborted transmission.
If the Range header is present in the request and the NFVO does
not support responding to range requests with a 206 response, it
shall return a 200 OK response instead.
in: header
required: false
type: string
- name : include_signatures
description: >
If this parameter is provided, the NFVO shall return the artifact
and related security information (such as signature and optional
certificate) in a ZIP archive.
If this parameter is not given, the NFVO shall provide only a copy
of the artifact file. This URI query parameter is a flag, i.e.
it shall have no value.
The NFVO shall support this parameter.
in: query
required: false
type: string
responses:
200:
description: >
200 OK
Shall be returned when the content of the artifact file has been read successfully.
If the "include_signatures" request URI parameter was not provided in the related request,
the payload body shall contain a copy of the artifact file from the NSD archive, as defined
by ETSI GS NFV-SOL 007, and the "Content-Type" HTTP header shall be set according to the
content type of the artifact file. If the artifact is encrypted, the header shall be set to
the value "application/cms" (IETF RFC 7193).
If the content type cannot be determined, the header shall be set to the value
"application/octet-stream". If the "include_signatures" request URI parameter was provided
in the related request, the "Content-Type" HTTP header shall be set to "application/zip"
and the payload body shall contain a ZIP archive which includes:
- a copy of the artifact file from the VNF package, as defined by ETSI GS NFVSOL 007
- the related security information (individual signature file and optional related individual
certificate file).
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
WWW-Authenticate:
type: string
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.
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
206:
description: >
206 PARTIAL CONTENT
If the NFVO supports range requests and the "include_signatures" request URI parameter was
not present in the related request, this response shall be returned when a single consecutive
byte range from the content of the artifact file has been read successfully according to the
request.
The response body shall contain the requested part of the artifact file from the NSD archive,
as defined by ETSI GS NFV-SOL 007.
The "Content-Type" HTTP header shall be set according to the
content type of the artifact file. If the content type cannot be determined, the header shall be
set to the value "application/octet-stream".
The "Content-Range" HTTP header shall be provided according to IETF RFC 7233.
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
WWW-Authenticate:
type: string
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.
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
401:
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
403:
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
404:
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
406:
# description: >
# If the related request contained an "Accept" header not compatible with the Content type
# "application/zip" but the "include_signatures" flag was provided, the NFVO shall respond
# with this response code.
# The "ProblemDetails" structure may be included with the "detail" attribute providing more
# information about the error.
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
405:
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
409:
# description: >
# Shall be returned upon the following 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 "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.
$ref: "../responses/SOL005_resp.yaml#/components/responses/409"
416:
# description: >
# The byte range passed in the "Range" header did not match any available byte range in the
# artifact file (e.g. "access after end of file").
# The response body may contain a ProblemDetails structure.
$ref: "../responses/SOL005_resp.yaml#/components/responses/416"
500:
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
503:
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/components/responses/504"
moscatelli
committed
###############################################################################
# PNF Descriptors #
###############################################################################
rameshnaraya
committed
'/pnf_descriptors':
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.5
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
parameters:
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235.
in: header
required: false
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
post:
summary: Create a new PNF descriptor resource.
description: >
The POST method is used to create a new PNF descriptor resource
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231.
in: header
required: true
type: string
- name: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231.
in: header
required: true
type: string
- name: CreatePnfdInfoRequest
in: body
required: true
schema:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/CreatePnfdInfoRequest"
description: >
Parameters of creating a PNF descriptor resource.
responses:
201:
description: >
201 CREATED
Shall be returned when a new "Individual PNF descriptor"
resource and the associated PNF descriptor identifier
has been created successfully.
The response body shall contain a representation of the
created PNF descriptor resource, as defined in clause 5.5.2.5.
The HTTP response shall include a "Location" HTTP header that
contains the resource URI of the created PNF descriptor resource.
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
schema:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfo"
headers:
Content-Type:
type: string
description: >
The MIME type of the body of the response.This header
field shall be present if the response has a non-empty message
body.
WWW-Authenticate:
type: string
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.
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/components/responses/504"
summary: Query information about multiple PNF descriptor resources.
moscatelli
committed
description: >
rameshnaraya
committed
"The GET method queries information about multiple PNF descriptor
resources."
moscatelli
committed
- name: filter
in: query
required: false
type: string
description: >
Attribute-based filtering expression according to clause 5.2
of ETSI GS NFV-SOL 013.
The NFVO shall support receiving this filtering parameter as part
of the URI query string. The OSS/BSS may supply this parameter.
All attribute names that appear in the PnfdInfo and in data types
referenced from it shall be supported by the NFVO in the filter expression.
moscatelli
committed
- name: all_fields
in: query
required: false
type: string
description: >
Include all complex attributes in the response. See clause 5.3
of ETSI GS NFV-SOL 013 for details. The NFVO shall support this parameter.
moscatelli
committed
- name: fields
in: query
required: false
type: string
description: >
Complex attributes to be included into the response. See clause 5.3 of
ETSI GS NFV-SOL 013 for details.
The NFVO should support this parameter.
moscatelli
committed
- name: exclude_fields
in: query
required: false
type: string
description: >
Complex attributes to be excluded from the response. See clause 5.3
of ETSI GS NFV-SOL 013 for details.
The NFVO should support this parameter.
moscatelli
committed
- name: exclude_default
in: query
required: false
type: string
description: >
Indicates to exclude the following complex attributes from the response.
See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFVO shall support
this parameter.
The following attributes shall be excluded from the PnfdInfo structure in
the response body if this parameter is provided, or none of the parameters
moscatelli
committed
"all_fields," "fields", "exclude_fields", "exclude_default" are provided:
- userDefinedData
- onboardingFailureDetails
moscatelli
committed
- name: nextpage_opaque_marker
in: query
type: string
required: false
description: >
Marker to obtain the next page of a paged response. Shall be supported by
the NFVO if the NFVO supports alternative 2 (paging) according to clause
5.4.2.1 of ETSI GS NFV SOL 013 for this resource.
moscatelli
committed
description: >
rameshnaraya
committed
200 OK
moscatelli
committed
Shall be returned when information about zero or more PNF descriptors has
been queried successfully.
The response body shall contain in an array the representations of zero or
more PNF descriptors, as defined in clause 5.5.2.5.
If the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of
ETSI GS NFV-SOL 013 for this resource, inclusion of the Link HTTP header in
this response shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013.
rameshnaraya
committed
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
moscatelli
committed
type: string
rameshnaraya
committed
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.
rameshnaraya
committed
maximum: 1
minimum: 0
moscatelli
committed
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
moscatelli
committed
minimum: 1
moscatelli
committed
Link:
description: >
Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
type: string
maximum: 1
minimum: 0
rameshnaraya
committed
schema:
description: >
Information about zero or more PNF descriptors.
The response body shall contain a representation in an array the representations
of zero or more PNF descriptors, as defined in clause 5.5.2.2.
If the NFVO supports alternative 2 (paging) according to clause 4.7.2.1 for this resource,
inclusion of the Link HTTP header in this response shall follow the provisions in clause 4.7.2.3.
moscatelli
committed
type: array
rameshnaraya
committed
items:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfo"
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
rameshnaraya
committed
404:
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/components/responses/504"
moscatelli
committed
###############################################################################
# Individual PNF Descriptor #
###############################################################################
rameshnaraya
committed
'/pnf_descriptors/{pnfdInfoId}':
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.6
parameters:
moscatelli
committed
- name: pnfdInfoId
description: >
Identifier of the individual PNF descriptor resource.
moscatelli
committed
in: path
moscatelli
committed
type: string
summary: Read an individual PNFD resource.
moscatelli
committed
description: >
The GET method reads information about an individual PNF descriptor.
parameters:
moscatelli
committed
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
- name: Accept
in: header
required: true
type: string
description: >
Content-Types that are acceptable for the response. This header
field shall be present if the response is expected to have a non-empty
message body.
- name: Authorization
in: header
required: false
type: string
description: >
The authorization token for the request. Details are specified
in clause 4.5.3 of GS NFV-SOL 005.
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
moscatelli
committed
description: >
moscatelli
committed
Shall be returned when information about the individual PNFD
descriptor has been read successfully.
The response body shall contain a representation of the
individual PNF descriptor, as defined in clause 5.5.2.5.
rameshnaraya
committed
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
moscatelli
committed
type: string
rameshnaraya
committed
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.
rameshnaraya
committed
maximum: 1
minimum: 0
moscatelli
committed
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
moscatelli
committed
minimum: 1
rameshnaraya
committed
schema:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfo"
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
rameshnaraya
committed
404:
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/components/responses/504"
patch:
summary: Modify the user defined data of an individual PNF descriptor resource.
moscatelli
committed
description: >
The PATCH method modifies the user defined data of an individual PNF descriptor resource.
parameters:
- name: Accept
in: header
required: true
type: string
moscatelli
committed
description: >
Content-Types that are acceptable for the response. This header
field shall be present if the response is expected to have a non-empty
message body.
- name: Content-Type
in: header
required: true
type: string
description: >
The MIME type of the body of the request. This header field
shall be present if the request has a non-empty message body.
- name: PnfdInfoModifications
moscatelli
committed
in: body
required: true
schema:
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfoModifications"
moscatelli
committed
description: >
Parameters for the modification of an individual
PNF descriptor resource, as defined in clause 5.5.2.4.
The Content-Type header shall be set to "application/merge-patch+json"
according to IETF RFC 7396.
moscatelli
committed
Shall be returned when the operation has been accepted
and completed successfully.
The response body shall contain attribute modifications
for an 'Individual PNF Descriptor' resource (see clause 5.5.2.4).
$ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfoModifications"
moscatelli
committed
type: string
description: >
The MIME type of the body of the response.This header
field shall be present if the response has a non-empty message
body.
moscatelli
committed
type: string
rameshnaraya
committed
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.
maximum: 1
moscatelli
committed
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
rameshnaraya
committed
404:
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
$ref: "../responses/SOL005_resp.yaml#/components/responses/412"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/components/responses/504"
moscatelli
committed
delete:
summary: Delete an individual PNF descriptor resource.
description: >
The DELETE method deletes an individual PNF descriptor resource.
An individual PNF descriptor resource can only be deleted when t
here is no NS instance using it or there is NSD referencing it.
To delete all PNFD versions identified by a particular value of
the "pnfdInvariantId" attribute, the procedure is to first use t
he GET method with filter "pnfdInvariantId" towards the PNF
descriptors resource to find all versions of the PNFD. Then,
he API consumer uses the DELETE method described in this clause
to delete each PNFD version individually.
This method shall follow the provisions specified in the Tables
5.4.6.3.5-1 and 5.4.6.3.5-2 for URI query parameters, request
and response data structures, and response codes.
responses:
204:
description: >
204 NO CONTENT
Shall be returned when the operation
has completed successfully.
headers:
WWW-Authenticate:
type: string
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.
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/components/responses/504"
moscatelli
committed
###############################################################################
moscatelli
committed
###############################################################################
rameshnaraya
committed
'/pnf_descriptors/{pnfdInfoId}/pnfd_content':
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.7
parameters:
moscatelli
committed
- name: pnfdInfoId
description: >
Identifier of the individual PNF descriptor.
This identifier can be retrieved from the resource referenced
by the "Location" HTTP header in the response to a POST request
creating a new PNF descriptor resource. It can also be retrieved
from the "id" attribute in the payload body of that response.
moscatelli
committed
in: path
moscatelli
committed
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
summary: Fetch the content of a PNFD.
moscatelli
committed
description: >
The GET method fetches the content of the PNFD archive.
The content of the PNFD archive is provided as onboarded,
i.e. depending on the security option used, the CSAR or
the CSAR wrapped in a ZIP archive together with an external
signature is returned, as defined in clause 5.1 of ETSI GS NFV-SOL 004.
NOTE: Information about the applicable security option can be obtained
by evaluating the "archiveSecurityOption" attribute in the "pnfdInfo" structure.
This method shall follow the provisions specified in the Tables 5.4.7.3.2-1
and 5.4.7.3.2-2 for URI query parameters, request and response data structures,
and response codes.
moscatelli
committed
- name: Accept
description: >
Content-Types that are acceptable for the response.
in: header
required: true
type: string
enum:
- text/plain
- name: Range
description: >
The request may contain a "Range" HTTP header to obtain
single range of bytes from the PNFD archive. This can be
used to continue an aborted transmission.
If the NFVO does not support range requests, the NFVO
shall ignore the "Range" header, process the GET request,
and return the whole PNFD archive with a 200 OK response
(rather than returning a 4xx error status code).
in: header
required: false
type: string
moscatelli
committed
description: >
moscatelli
committed
Shall be returned when the content of the PNFD archive has
been read successfully.
The payload body shall contain a copy of the PNFD archive
The "Content-Type" HTTP header shall be set to "application/zip".
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
WWW-Authenticate:
moscatelli
committed
type: string
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.
maximum: 1
moscatelli
committed
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
206:
description: >
206 PARTIAL CONTENT
If the NFVO supports range requests, this response shall be returned
when a single consecutive byte range from the content of the PNFD archive
has been read successfully according to the request.
The response body shall contain the requested part of the PNFD archive.
The "Content-Range" HTTP header shall be provided according to IETF RFC 7233.
The "Content-Type" HTTP header shall be set as defined above for the "200 OK" response.
headers:
Content-Type:
description: >
The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
Content-Range:
description: >
The "Content-Range" HTTP header shall be provided according to IETF RFC 7233.
type: string
maximum: 1
minimum: 1
WWW-Authenticate:
type: string
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.
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
rameshnaraya
committed
404:
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
rameshnaraya
committed
409:
Samir Medjiah
committed
# description: >
# 409 CONFLICT
# Shall be returned upon the following 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.
$ref: "../responses/SOL005_resp.yaml#/components/responses/409"
$ref: "../responses/SOL005_resp.yaml#/components/responses/416"
rameshnaraya
committed
500:
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
rameshnaraya
committed
503:
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
504:
$ref: "../responses/SOL005_resp.yaml#/components/responses/504"
summary: Upload the content of a PNFD.
moscatelli
committed
description: >
The PUT method is used to upload the content of a PNFD archive.
This resource represents the content of the individual PNF descriptor, i.e. PNFD content.
The client can use this resource to upload and download the content of the PNFD.
moscatelli
committed
- name: Accept
description: >
Content-Types that are acceptable for the response.
in: header
required: true
type: string
enum:
- text/plain
- name: Content-type
description: >
The request shall set the "Content-Type" HTTP header to "application/zip".
in: header
type: string
enum:
- application/zip
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
202:
description: >
202 ACCEPTED
Shall be returned when the PNFD archive has been accepted for uploading,
but the processing has not been completed. It is expected to take some
time for processing (asynchronous mode).
The response body shall be empty.
The API consumer can track the uploading progress by receiving the
"PnfdOnBoardingNotification" and "PnfdOnBoardingFailureNotification"
from the NFVO or by reading the status of the individual PNF descriptor
resource using the GET method.
headers:
WWW-Authenticate:
type: string
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.
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
moscatelli
committed
description: >
moscatelli
committed
Shall be returned when the PNFD archive content has been
uploaded and validated successfully.
rameshnaraya
committed
The response body shall be empty.
headers:
WWW-Authenticate:
type: string
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.
maximum: 1
minimum: 0
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
minimum: 1
rameshnaraya
committed
400:
$ref: "../responses/SOL005_resp.yaml#/components/responses/400"
rameshnaraya
committed
401:
$ref: "../responses/SOL005_resp.yaml#/components/responses/401"
rameshnaraya
committed
403:
$ref: "../responses/SOL005_resp.yaml#/components/responses/403"
rameshnaraya
committed
404:
$ref: "../responses/SOL005_resp.yaml#/components/responses/404"
rameshnaraya
committed
405:
$ref: "../responses/SOL005_resp.yaml#/components/responses/405"
rameshnaraya
committed
406:
$ref: "../responses/SOL005_resp.yaml#/components/responses/406"
Samir Medjiah
committed
# description: >
# 409 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.
$ref: "../responses/SOL005_resp.yaml#/components/responses/409"
$ref: "../responses/SOL005_resp.yaml#/components/responses/500"
$ref: "../responses/SOL005_resp.yaml#/components/responses/503"
###############################################################################
# PNFD #
###############################################################################
'/pnf_descriptors/{pnfdInfoId}/pnfd':
#ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.7a
parameters:
- name: pnfdInfoId
description: >
Identifier of the individual PNF descriptor.
This identifier can be retrieved from the resource referenced
by the "Location" HTTP header in the response to a POST request
creating a new PNF descriptor resource. It can also be retrieved
from the "id" attribute in the payload body of that response.
in: path
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.