Newer
Older
authorization, or error details if the corresponding HTTP request
has provided an invalid authorization token.
maximum: 1
moscatelli
committed
minimum: 0
Samir Medjiah
committed
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
Samir Medjiah
committed
minimum: 1
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
schema:
type: array
items:
moscatelli
committed
$ref: "definitions/NSLifecycleManagement_def.yaml#/definitions/NsLcmOpOcc"
400:
$ref: "responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "responses/SOL005_resp.yaml#/responses/404"
405:
$ref: "responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "responses/SOL005_resp.yaml#/responses/406"
409:
$ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-inconsistent-state"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
moscatelli
committed
###############################################################################
# Individual NS lifecycle operation occurrence #
###############################################################################
'/ns_lcm_op_occs/{nsLcmOpOccId}':
rameshnaraya
committed
#ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.10
parameters:
- name: nsLcmOpOccId
description: >
Identifier of a NS lifecycle management operation occurrence.
in: path
type: string
required: true
moscatelli
committed
get:
summary: Read an individual NS LCM operation occurrence resource.
moscatelli
committed
The client can use this method to retrieve status information about
a NS lifecycle management operation occurrence by
reading an individual "NS LCM operation occurrence" resource.
This method shall follow the provisions specified in the
Tables 6.4.10.3.2-1 and 6.4.10.3.2-2 for URI query parameters,
request and response data structures, and response codes.
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
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
Samir Medjiah
committed
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
moscatelli
committed
Information about a NS LCM operation occurrence was
queried successfully.
The response body shall contain status information about a NS
lifecycle management operation occurrence (see clause 6.5.2.3).
moscatelli
committed
type: "object"
properties:
NsLcmOpOcc:
$ref: "definitions/NSLifecycleManagement_def.yaml#/definitions/NsLcmOpOcc"
headers:
Content-Type:
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
minimum: 1
rameshnaraya
committed
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.
moscatelli
committed
minimum: 0
Samir Medjiah
committed
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
Samir Medjiah
committed
minimum: 1
400:
$ref: "responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "responses/SOL005_resp.yaml#/responses/404"
405:
$ref: "responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "responses/SOL005_resp.yaml#/responses/406"
409:
$ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-inconsistent-state"
416:
$ref: "responses/SOL005_resp.yaml#/responses/416"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
moscatelli
committed
$ref: "responses/SOL005_resp.yaml#/responses/503"
moscatelli
committed
###############################################################################
# Retry operation task #
###############################################################################
'/ns_lcm_op_occs/{nsLcmOpOccId}/retry':
#ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.11
parameters:
- name: nsLcmOpOccId
description: >
Identifier of a NS lifecycle management operation occurrence to be retried.
moscatelli
committed
This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response
to a POST request triggering a NS LCM operation. It can also be retrieved from the "nsLcmOpOccId"
attribute in the NsLcmOperationOccurrenceNotification.
in: path
type: string
required: true
post:
summary: Retry a NS lifecycle management operation occurrence.
description: >
The POST method initiates retrying a NS lifecycle management operation
if that operation has experienced a temporary
failure, i.e. the related "NS LCM operation occurrence" is in "FAILED_TEMP" state.
This method shall follow the provisions specified in the
Tables 6.4.11.3.1-1 and 6.4.11.3.1-2 for URI query parameters,
request and response data structures, and response codes.
parameters:
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
Samir Medjiah
committed
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
responses:
202:
$ref: "responses/SOL005_resp.yaml#/responses/202"
400:
$ref: "responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "responses/SOL005_resp.yaml#/responses/404-task-resource-not-exists-NS-LCM"
405:
$ref: "responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "responses/SOL005_resp.yaml#/responses/406"
409:
$ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-state-conflict-not-FAILED_TEMP"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
moscatelli
committed
###############################################################################
# Rollback a NS lifecycle management operation occurrence. #
###############################################################################
'/ns_lcm_op_occs/{nsLcmOpOccId}/rollback':
#ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.12
parameters:
- name: nsLcmOpOccId
description: >
Identifier of a NS lifecycle management operation occurrence to be rolled back.
moscatelli
committed
This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response
to a POST request triggering a NS LCM operation. It can also be retrieved from the "nsLcmOpOccId"
attribute in the NsLcmOperationOccurrenceNotification.
in: path
required: true
type: string
post:
summary: Rollback a NS lifecycle management operation occurrence.
description: >
The POST method initiates rolling back a NS lifecycle operation
if that operation has experienced a temporary failure,
i.e. the related "NS LCM operation occurrence" is in "FAILED_TEMP" state.
This method shall follow the provisions specified in the
Tables 6.4.12.3.1-1 and 6.4.12.3.1-2 for URI query parameters,
request and response data structures, and response codes.
parameters:
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
Samir Medjiah
committed
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
responses:
202:
$ref: "responses/SOL005_resp.yaml#/responses/202"
400:
$ref: "responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "responses/SOL005_resp.yaml#/responses/404-not-found"
405:
$ref: "responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "responses/SOL005_resp.yaml#/responses/406"
409:
$ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-state-conflict-not-FAILED_TEMP"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
moscatelli
committed
###############################################################################
# Continue a NS lifecycle management operation occurrence. #
###############################################################################
'/ns_lcm_op_occs/{nsLcmOpOccId}/continue':
#ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.13
parameters:
- name: nsLcmOpOccId
description: >
Identifier of a NS lifecycle management operation occurrence to be continued.
in: path
required: true
type: string
moscatelli
committed
post:
summary: Continue a NS lifecycle management operation occurrence.
description: >
The POST method initiates continuing an NS lifecycle operation if that operation has experienced a temporary failure,
i.e. the related "NS LCM operation occurrence" is in "FAILED_TEMP" state.
This method shall follow the provisions specified in the Tables 6.4.13.3.1-1 and 6.4.13.3.1-2 for URI query parameters,
request and response data structures, and response codes.
parameters:
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
Samir Medjiah
committed
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
responses:
202:
$ref: "responses/SOL005_resp.yaml#/responses/202"
400:
$ref: "responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "responses/SOL005_resp.yaml#/responses/404-not-found"
405:
$ref: "responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "responses/SOL005_resp.yaml#/responses/406"
409:
$ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-state-conflict-not-FAILED_TEMP"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
moscatelli
committed
###############################################################################
# Fail operation task #
###############################################################################
'/nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}/fail':
#ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.14
parameters:
- name: nsLcmOpOccId
description: >
Identifier of a NS lifecycle management operation occurrence to be marked as "failed".
moscatelli
committed
This identifier can be retrieved from the resource referenced by
he "Location" HTTP header in the response
to a POST request triggering a NS LCM operation.
It can also be retrieved from the "nsLcmOpOccId"
attribute in the NsLcmOperationOccurrenceNotification.
in: path
required: true
type: string
post:
summary: Mark a NS lifecycle management operation occurrence as failed.
description: >
The POST method marks a NS lifecycle management operation
occurrence as "finally failed" if that operation
occurrence is in "FAILED_TEMP" state.
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
Samir Medjiah
committed
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
schema:
type: "object"
description: >
The state of the NS lifecycle management operation
occurrence was changed successfully.
The response shall include a representation of the NS
lifecycle management operation occurrence resource.
properties:
NsLcmOpOcc:
$ref: "definitions/NSLifecycleManagement_def.yaml#/definitions/NsLcmOpOcc"
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.
moscatelli
committed
minimum: 1
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.
moscatelli
committed
minimum: 0
Samir Medjiah
committed
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
Samir Medjiah
committed
minimum: 1
400:
$ref: "responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "responses/SOL005_resp.yaml#/responses/404-not-found"
405:
$ref: "responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "responses/SOL005_resp.yaml#/responses/406"
409:
$ref: "responses/NSLifecycleManagement_resp.yaml#/responses/409-state-conflict-not-FAILED_TEMP"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
moscatelli
committed
###############################################################################
# Cancel operation task #
###############################################################################
'/nslcm/v1/ns_lcm_op_occs/{nsLcmOpOccId}/cancel':
#ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.15
parameters:
- name: nsLcmOpOccId
description: >
Identifier of a NS lifecycle management operation occurrence to be canceled.
moscatelli
committed
This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response
to a POST request triggering a NS LCM operation. It can also be retrieved from the "nsLcmOpOccId"
attribute in the NsLcmOperationOccurrenceNotification.
in: path
required: true
type: string
post:
summary: Cancel a NS lifecycle management operation occurrence.
description: >
The POST method initiates canceling an ongoing NS lifecycle
management operation while it is being executed or
rolled back, i.e. the related "NS LCM operation occurrence" is
either in "PROCESSING" or "ROLLING_BACK" state.
This method shall follow the provisions specified in the
Tables 6.4.15.3.1-1 and 6.4.15.3.1-2 for URI query parameters,
request and response data structures, and response codes.
parameters:
moscatelli
committed
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
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
Samir Medjiah
committed
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
moscatelli
committed
- name: "body"
in: "body"
required: true
schema:
type: "object"
required:
- "CancelMode"
properties:
CancelMode:
$ref: "definitions/NSLifecycleManagement_def.yaml#/definitions/CancelMode"
description: >
The POST request to this resource shall include a CancelMode
structure in the payload body to choose between "graceful" and
"forceful" cancellation.
responses:
202:
$ref: "responses/SOL005_resp.yaml#/responses/202"
400:
$ref: "responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "responses/SOL005_resp.yaml#/responses/404-task-resource-not-exists-NS-LCM"
405:
$ref: "responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "responses/SOL005_resp.yaml#/responses/406"
409:
moscatelli
committed
description: >
rameshnaraya
committed
409 Conflict.
Error: The operation cannot be executed currently, due
to a conflict with the state of the NS LCM operation
occurrence resource.
Typically, this is due to the fact that the operation
occurrence is not in STARTING, PROCESSING or
ROLLING_BACK state.
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.
maximum: 1
minimum: 0
schema:
$ref: "definitions/SOL005_def.yaml#/definitions/ProblemDetails"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
moscatelli
committed
###############################################################################
# Subscriptions #
###############################################################################
#ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.16
moscatelli
committed
post:
summary: Subscribe to NS lifecycle change notifications.
description: >
The POST method creates a new subscription.
This method shall support the URI query parameters, request and response data structures, and response codes, as
specified in the Tables 6.4.16.3.1-1 and 6.4.16.3.1-2.
Creation of two subscription resources with the same callbackURI and the same filter can result in performance
degradation and will provide duplicates of notifications to the OSS, and might make sense only in very rare use cases.
Consequently, the NFVO may either allow creating a subscription resource if another subscription resource with the
same filter and callbackUri already exists (in which case it shall return the "201 Created" response code), or may decide
to not create a duplicate subscription resource (in which case it shall return a "303 See Other" response code referencing
the existing subscription resource with the same filter and callbackUri).
parameters:
moscatelli
committed
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
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
Samir Medjiah
committed
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
moscatelli
committed
- name: "body"
in: "body"
required: true
schema:
type: "object"
required:
- "LccnSubscriptionRequest"
properties:
LccnSubscriptionRequest:
$ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/LccnSubscriptionRequest"
description: >
Details of the subscription to be created, as defined in clause 6.5.2.2.
moscatelli
committed
The subscription was created successfully.
The response body shall contain a representation of
the created subscription resource.
The HTTP response shall include a "Location:"
HTTP header that points to the created subscription resource.
moscatelli
committed
type: "object"
properties:
LccnSubscription:
$ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/LccnSubscription"
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.
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.
Samir Medjiah
committed
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
Samir Medjiah
committed
minimum: 1
moscatelli
committed
description: >
rameshnaraya
committed
See Other.
moscatelli
committed
A subscription with the same callbackURI and the
same filter already exits and the policy of the NFVO
is to not create redundant subscriptions.
The HTTP response shall include a "Location"
HTTP header that contains the resource URI of the
existing subscription resource.
The response body shall be empty.
headers:
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.
maximum: 1
minimum: 0
Samir Medjiah
committed
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
Samir Medjiah
committed
minimum: 1
400:
$ref: "responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "responses/SOL005_resp.yaml#/responses/404-task-not-suported-NS-LCM"
405:
$ref: "responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "responses/SOL005_resp.yaml#/responses/406"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
moscatelli
committed
get:
rameshnaraya
committed
Query Subscription Information.
The GET method queries the list of active subscriptions of the
functional block that invokes the method. It can be used e.g. for
resynchronization after error situations.
parameters:
Samir Medjiah
committed
- name: filter
in: query
required: false
type: string
description: >
Attribute-based filtering expression according to clause 4.3.2.
The NFVO shall support receiving this parameter as part of the URI query string.
The OSS/BSS may supply this parameter.
All attribute names that appear in the LccnSubscription and in data types
referenced from it shall be supported by the NFVO in the filter expression.
- name: nextpage_opaque_marker
in: query
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 4.7.2.1 for this resource.
required: false
type: string
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
Samir Medjiah
committed
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
moscatelli
committed
The list of subscriptions was queried successfully.
The response body shall contain the representations of all active
subscriptions of the functional block that invokes the method.
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.
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.
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
Samir Medjiah
committed
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
Samir Medjiah
committed
minimum: 1
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
type: array
items:
properties:
LccnSubscription:
$ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/LccnSubscription"
moscatelli
committed
description: >
rameshnaraya
committed
Bad Request.
Invalid attribute-based filtering parameters.
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.
maximum: 1
minimum: 0
schema:
$ref: "definitions/SOL005_def.yaml#/definitions/ProblemDetails"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "responses/SOL005_resp.yaml#/responses/404-task-not-suported-NS-LCM"
405:
$ref: "responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "responses/SOL005_resp.yaml#/responses/406"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
moscatelli
committed
###############################################################################
# Individual subscription #
###############################################################################
'/subscriptions/{subscriptionId}':
#ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.17
parameters:
- name: subscriptionId
description: >
Identifier of this subscription.
in: path
type: string
required: true
get:
description: >
The GET method retrieves information about a subscription by reading an individual subscription resource.
This method shall support the URI query parameters, request and response data structures, and response codes, as
specified in the Tables 6.4.17.3.2-1 and 6.4.17.3.2-2
parameters:
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
Samir Medjiah
committed
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
moscatelli
committed
responses:
moscatelli
committed
The operation has completed successfully.
The response body shall contain a representation of
the subscription resource.
moscatelli
committed
type: "object"
properties:
LccnSubscription:
$ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/LccnSubscription"
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.
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
Samir Medjiah
committed
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
Samir Medjiah
committed
minimum: 1
400:
$ref: "responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "responses/SOL005_resp.yaml#/responses/403"
404:
$ref: "responses/SOL005_resp.yaml#/responses/404-task-not-suported-NS-LCM"
405:
$ref: "responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "responses/SOL005_resp.yaml#/responses/406"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
delete:
description: >
The DELETE method terminates an individual subscription.
This method shall support the URI query parameters, request and response data structures, and response codes, as
specified in the Tables 6.4.17.3.5-1 and 6.4.17.3.5-2.
parameters:
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
Samir Medjiah
committed
- 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
The subscription resource was deleted successfully.
headers:
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.
maximum: 1
minimum: 0
Samir Medjiah
committed
Version:
description: >
Version of the API used in the response.
type: string
maximum: 1
Samir Medjiah
committed
minimum: 1
400:
$ref: "responses/SOL005_resp.yaml#/responses/400"
401:
$ref: "responses/SOL005_resp.yaml#/responses/401"
403:
$ref: "responses/SOL005_resp.yaml#/responses/403"
405:
$ref: "responses/SOL005_resp.yaml#/responses/405"
406:
$ref: "responses/SOL005_resp.yaml#/responses/406"
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
moscatelli
committed
##################################################################################
# Notification endpoint #
# Dummy URI is used for testing. #
# In real, resource URI is provided by the client when creating the subscription.#
##################################################################################
'/URI_is_provided_by_the_client_when_creating_the_subscription-NsLcmOperationOccurrenceNotification':
#ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.18
post:
summary: Notify about NS lifecycle change
description: >
The POST method delivers a notification from the server to the client.
This method shall support the URI query parameters, request and response data structures, and response codes, as
specified in the Tables 6.4.18.3.1-1 and 6.4.18.3.1-2.
A notification about lifecycle changes triggered by a NS LCM.
operation occurrence.
in: body
required: true
schema:
properties:
NsLcmOperationOccurrenceNotification:
$ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsLcmOperationOccurrenceNotification"
- name: Accept
description: >
Content-Types that are acceptable for the response.
Reference: IETF RFC 7231
in: header
required: true
type: string
- name: Authorization
description: >
The authorization token for the request.
Reference: IETF RFC 7235
in: header
required: false
type: string
- name: Content-Type
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
in: header
required: true
moscatelli
committed
type: string
Samir Medjiah
committed
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header