Commit 395d3b69 authored by rameshnaraya's avatar rameshnaraya

Merge Request issue.

Re committing NSLCM files.
parent 5af7bb2f
Pipeline #161 passed with stage
in 0 seconds
......@@ -2,9 +2,9 @@ swagger: "2.0"
info:
version: "2.4.1"
title: DRAFT - SOL005 - NS Lifecycle Management Interface
title: SOL005 - NS Lifecycle Management Interface
description: >
DRAFT - SOL005 - NS Lifecycle Management Interface
SOL005 - NS Lifecycle Management Interface
IMPORTANT: Please note that this file might be not aligned to the current
version of the ETSI Group Specification it refers to and has not been
approved by the ETSI NFV ISG. In case of discrepancies the published ETSI
......@@ -32,16 +32,10 @@ paths:
'/ns_instances':
#ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.2
post:
summary: "NS instances"
summary: "Create a NS instance resource."
description: >
The POST method creates a new NS instance resource.
parameters:
- name: createNsRequest
description: "The NS Instance creation parameters."
in: body
required: true
schema:
$ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/CreateNsRequest"
- name: Accept
description: >
Content-Types that are acceptable for the response.
......@@ -62,38 +56,52 @@ paths:
Reference: IETF RFC 7231
in: header
required: true
type: string
responses:
type: string
- name: "body"
in: "body"
required: true
schema:
type: "object"
required:
- "CreateNsRequest"
properties:
CreateNsRequest:
$ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/CreateNsRequest"
description: >
The NS creation parameters, as defined in clause 6.5.2.7.
responses:
201:
description: >
201 Created.
A NS Instance identifier was created successfully.
The response body shall contain a representation of
the created NS instance, as defined in clause 6.5.2.8.
The HTTP response shall include a "Location" HTTP
header that contains the resource URI of the created
NS instance.
description: "201 Created."
schema:
type: "object"
description: >
A NS Instance identifier was created successfully.
The response body shall contain a representation of
the created NS instance, as defined in clause 6.5.2.8.
The HTTP response shall include a "Location" HTTP
header that contains the resource URI of the created
NS instance.
properties:
NsInstance:
$ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsInstance"
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
type: "string"
description: >
The HTTP response shall include a Location HTTP header
that contains the resource URI of the new NS descriptor resource.
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.
type: string
maximum: 1
minimum: 0
schema:
$ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsInstance"
authorization, or error details if the corresponding HTTP request
has provided an invalid authorization token.
400:
$ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
401:
......@@ -115,7 +123,7 @@ paths:
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
get:
summary: "NS instances"
summary: "Query multiple NS instances."
description: >
Query NS Instances.
......@@ -188,12 +196,13 @@ paths:
responses:
200:
description: >
200 OK
200 OK.
Information about zero or more NS instances was
queried successfully.
The response body shall contain representations of
zero or more NS instances.
zero or more NS instances, as defined in
clause 6.5.2.8.
headers:
Content-Type:
description: The MIME type of the body of the response.
......@@ -201,17 +210,17 @@ paths:
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.
type: string
maximum: 1
minimum: 0
request has provided an invalid authorization token.
schema:
type: array
items:
$ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsInstance"
properties:
NsInstance:
$ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsInstance"
400:
$ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
401:
......@@ -231,7 +240,8 @@ paths:
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
$ref: "responses/SOL005_resp.yaml#/responses/503"
###############################################################################
# Individual NS instance #
###############################################################################
......@@ -245,7 +255,7 @@ paths:
type: string
required: true
get:
summary: Individual NS instance
summary: Read an individual NS instance resource.
description: >
The GET method retrieves information about a NS instance by
reading an individual NS instance resource.
......@@ -273,28 +283,38 @@ paths:
type: string
responses:
200:
description: >
Information about an individual NS instance was
queried successfully.
The response body shall contain a representation of
the NS instance.
description: 200 OK.
schema:
type: "object"
description: >
Information about an individual NS instance was
queried successfully.
The response body shall contain a representation of
the NS instance.
properties:
NsInstance:
$ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsInstance"
headers:
Location:
type: "string"
description: >
The HTTP response shall include a Location HTTP header
that contains the resource URI of the new NS descriptor resource.
Content-Type:
description: The MIME type of the body of the response.
type: string
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.
maximum: 1
minimum: 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.
type: string
authorization, or error details if the corresponding HTTP request
has provided an invalid authorization token.
maximum: 1
minimum: 0
schema:
$ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsInstance"
400:
$ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector"
401:
......@@ -317,7 +337,7 @@ paths:
$ref: "responses/SOL005_resp.yaml#/responses/503"
delete:
summary: Individual NS instance.
summary: Delete NS instance resource.
description: >
Delete NS Identifier
......@@ -381,48 +401,46 @@ paths:
type: string
required: true
post:
summary: Instantiate NS task.
summary: Instantiate a NS.
description: >
The POST method requests to instantiate a NS instance resource.
parameters:
- name: InstantiateNsRequest
- 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
- name: "body"
in: "body"
required: true
schema:
type: "object"
required:
- "InstantiateNsRequest"
properties:
InstantiateNsRequest:
$ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/InstantiateNsRequest"
description: >
Parameters for the instantiate NS operation, as defined in clause 6.5.2.10.
in: body
required: true
schema:
$ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/InstantiateNsRequest"
- 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
responses:
202:
description: >
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 LCM operation occurrence" resource
corresponding to the operation.
$ref: "responses/NSLifecycleManagement_resp.yaml#/responses/202-with-Location"
400:
$ref: "responses/SOL005_resp.yaml#/responses/400"
401:
......@@ -457,37 +475,43 @@ paths:
type: string
required: true
post:
summary: Scale NS task.
summary: Scale a NS instance.
description: >
The POST method requests to scale a NS instance resource.
parameters:
- name: ScaleNsRequest
description: Represents a request for the scale NS operation
in: body
required: true
schema:
$ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/ScaleNsRequest"
- 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
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
- name: "body"
in: "body"
required: true
schema:
type: "object"
required:
- "ScaleNsRequest"
properties:
ScaleNsRequest:
$ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/ScaleNsRequest"
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
in: header
required: true
type: string
Parameters for the scale NS operation, as defined in clause 6.5.2.13.
responses:
202:
$ref: "responses/NSLifecycleManagement_resp.yaml#/responses/202-with-Location"
......@@ -523,41 +547,47 @@ paths:
type: string
required: true
post:
summary: Update NS task.
summary: Updates a NS instance.
description: >
Scale NS instance.
The POST method requests to scale a NS instance resource.
parameters:
- name: UpdateNsRequest
description: Represents a request for the scale NS operation.
in: body
required: true
schema:
$ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/UpdateNsRequest"
- 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
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
- name: "body"
in: "body"
required: true
schema:
type: "object"
required:
- "UpdateNsRequest"
properties:
UpdateNsRequest:
$ref: "definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/UpdateNsRequest"
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
in: header
required: true
type: string
Parameters for the update NS operation, as defined in clause 6.5.2.11.
responses:
202:
$ref: "responses/NSLifecycleManagement_resp.yaml#/responses/202-with-Location"
$ref: "responses/NSLifecycleManagement_resp.yaml#/responses/202-with-Location"
400:
$ref: "responses/SOL005_resp.yaml#/responses/400"
401:
......@@ -576,59 +606,67 @@ paths:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
###############################################################################
# Heal NS task #
# Terminate NS task #
###############################################################################
'/ns_instances/{nsInstanceId}/heal':
#ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.7
'/ns_instances/{nsInstanceId}/terminate':
#ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.8
parameters:
- name: nsInstanceId
description: >
Identifier of the NS instance to be healed.
The identifier of the NS instance to be terminated.
in: path
type: string
required: true
post:
summary: Heal NS task.
summary: Terminate a NS instance.
description: >
Heal NS.
The POST method requests to heal a NS instance resource.
This method shall follow the provisions specified in the Tables 6.4.7.3.1-1 and
6.4.7.3.1-2 for URI query parameters,
request and response data structures, and response codes.
Terminate NS task.
The POST method terminates a NS instance. This method can only be
used with a NS instance in the INSTANTIATED
state. Terminating a NS instance does not delete the NS instance identifier,
but rather transitions the NS into the NOT_INSTANTIATED state.
This method shall support the URI query parameters, request and
response data structures, and response codes, as
specified in the Tables 6.4.8.3.1-1 and 6.8.8.3.1-2.
parameters:
- name: HealNsRequest
description: Parameters for the heal NS operation, as defined in clause 6.5.2.12.
in: body
required: true
schema:
$ref: "definitions/NSLifecycleManagement_def.yaml#/definitions/HealNsRequest"
- 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
- 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
- name: "body"
in: "body"
required: true
schema:
type: "object"
required:
- "TerminateNsRequest"
properties:
TerminateNsRequest:
$ref: "definitions/NSLifecycleManagement_def.yaml#/definitions/TerminateNsRequest"
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
in: header
required: true
type: string
The terminate NS request parameters, as defined in clause 6.5.2.14.
responses:
202:
$ref: "responses/NSLifecycleManagement_resp.yaml#/responses/202-with-Location"
$ref: "responses/NSLifecycleManagement_resp.yaml#/responses/202-with-Location"
400:
$ref: "responses/SOL005_resp.yaml#/responses/400"
401:
......@@ -646,59 +684,61 @@ paths:
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
$ref: "responses/SOL005_resp.yaml#/responses/503"
###############################################################################
# Terminate NS task #
# Heal NS task #
###############################################################################
'/ns_instances/{nsInstanceId}/terminate':
#ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.8
'/ns_instances/{nsInstanceId}/heal':
#ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.7
parameters:
- name: nsInstanceId
description: >
The identifier of the NS instance to be terminated.
Identifier of the NS instance to be healed.
in: path
type: string
required: true
post:
summary: Terminate NS task
description: >
Terminate NS task.
The POST method terminates a NS instance. This method can only be
used with a NS instance in the INSTANTIATED
state. Terminating a NS instance does not delete the NS instance identifier,
but rather transitions the NS into the NOT_INSTANTIATED state.
This method shall support the URI query parameters, request and
response data structures, and response codes, as
specified in the Tables 6.4.8.3.1-1 and 6.8.8.3.1-2.
summary: Heal a NS instance.
description: >
The POST method requests to heal a NS instance resource.
This method shall follow the provisions specified in the Tables 6.4.7.3.1-1 and
6.4.7.3.1-2 for URI query parameters,
request and response data structures, and response codes.
parameters:
- name: TerminateNsRequest
description: The terminate NS request parameters, as defined in clause 6.5.2.14.
in: body
required: true
schema:
$ref: "definitions/NSLifecycleManagement_def.yaml#/definitions/TerminateNsRequest"
- 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
- 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
- name: "body"
in: "body"
required: true
schema:
type: "object"
required:
- "HealNsRequest"
properties:
HealNsRequest:
$ref: "definitions/NSLifecycleManagement_def.yaml#/definitions/HealNsRequest"
description: >
The MIME type of the body of the request.
Reference: IETF RFC 7231
in: header
required: true
type: string
Parameters for the heal NS operation, as defined in clause 6.5.2.12.
responses:
202:
$ref: "responses/NSLifecycleManagement_resp.yaml#/responses/202-with-Location"
......@@ -719,7 +759,7 @@ paths:
500:
$ref: "responses/SOL005_resp.yaml#/responses/500"
503:
$ref: "responses/SOL005_resp.yaml#/responses/503"
$ref: "responses/SOL005_resp.yaml#/responses/503"
###############################################################################
# NS LCM operation occurrences #
......@@ -727,7 +767,7 @@ paths:
'/ns_lcm_op_occs':
#ETSI GS NFV-SOL 005 V2.4.1 location: 6.4.9
get:
summary: NS lifecycle operation occurrences.
summary: Query multiple NS LCM operation occurrences.
description: >
Get Operation Status.
The client can use this method to query status information about multiple NS lifecycle management operation
......@@ -789,9 +829,10 @@ paths:
responses:
200:
description: >
200 OK.
Status information for zero or more NS lifecycle
management operation occurrences was queried
successfully.
management operation occurrences was queried successfully.
The response body shall contain representations of
zero or more NS instances, as defined in
clause 5.5.2.13.
......@@ -802,17 +843,17 @@ paths:
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.
type: string
maximum: 1
minimum: 0
request has provided an invalid authorization token.