Skip to content
GitLab
Commits (42)
Hide whitespace changes
Inline Side-by-side
src/SOL005/NSFaultManagement/NSFaultManagement.yaml
View file @ 9f5f89cf
......@@ -27,6 +27,57 @@ produces:
- "application/json"
paths:
###############################################################################
# API Versions #
###############################################################################
'/api-versions':
get:
summary: Retrieve API version information
description: >
The GET method reads API version information. This method shall follow the provisions specified in
table 4.6.3.3.3.2-1 for request and response data structures, and response codes. URI query parameters are not
supported.
parameters:
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
type: string
responses:
200:
description: >
200 OK
API version information was read successfully.
The response body shall contain API version information, as defined in clause 4.4.1.7.
schema:
$ref: '../definitions/SOL005_def.yaml#/definitions/ApiVersionInformation'
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
Version:
description: The used API version.
type: string
maximum: 1
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' }
413: { $ref: '../responses/SOL005_resp.yaml#/responses/413' }
414: { $ref: '../responses/SOL005_resp.yaml#/responses/414' }
416: { $ref: '../responses/SOL005_resp.yaml#/responses/416' }
422: { $ref: '../responses/SOL005_resp.yaml#/responses/422' }
429: { $ref: '../responses/SOL005_resp.yaml#/responses/429' }
500: { $ref: '../responses/SOL005_resp.yaml#/responses/500' }
503: { $ref: '../responses/SOL005_resp.yaml#/responses/503' }
504: { $ref: '../responses/SOL005_resp.yaml#/responses/504' }
###############################################################################
# Alarms #
###############################################################################
'/alarms':
......@@ -38,16 +89,16 @@ paths:
The client can use this method to retrieve information about the alarm list.
parameters:
- name: "filter"
in: "query"
- name: filter
in: query
required: false
type: "string"
type: string
description: >
Attribute-based filtering parameters according to clause 4.3.2.
The NFVO shall support receiving filtering parameters as part of the URI query string.
The OSS/BSS may supply filtering parameters.
The following attribute names shall be supported in attribute-based
filtering parameters:
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.
The following attribute names shall be supported by the NFVO in the filter
expression:
- id
- nsInstanceId
- rootCauseFaultyComponent.faultyNestedNsInstanceId
......@@ -57,6 +108,13 @@ paths:
- eventType
- perceivedSeverity
- probableCause
- 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.
......@@ -82,8 +140,11 @@ paths:
description: >
200 OK
The request has succeeded.
Information about zero or more alarms was queried successfully.
The response body shall contain the list of related alarms.
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:
description: The MIME type of the body of the response.
......@@ -104,6 +165,12 @@ paths:
type: string
maximum: 1
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:
......@@ -441,16 +508,23 @@ paths:
Table 8.4.4.3.2-1: URI query parameters supported.
parameters:
- name: "filter"
in: "query"
- name: filter
in: query
required: false
type: "string"
type: string
description: >
Attribute-based filtering parameters according to clause 4.3.2.
The NFVO shall support receiving filtering parameters as part of the URI
query string. The OSS/BSS may supply filtering parameters.
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 FmSubscription and in data types
referenced from it shall be supported in attribute-based filtering parameters.
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.
......@@ -484,9 +558,13 @@ paths:
200 OK
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.
The response body shall contain in an array the representations
of all active subscriptions of the functional block that invokes
the method, i.e. zero or more representations of FM subscriptions,
as defined in clause 8.5.2.3.
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:
description: The MIME type of the body of the response.
......@@ -507,6 +585,12 @@ paths:
type: string
maximum: 1
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:
......
src/SOL005/NSFaultManagement/definitions/SOL005NSFaultManagement_def.yaml
View file @ 9f5f89cf
......@@ -168,11 +168,11 @@ definitions:
subscription:
description: >
Link to the related subscription.
$ref: "SOL005_def.yaml#/definitions/Link"
$ref: "SOL005_def.yaml#/definitions/NotificationLink"
alarm:
description: >
Link to the resource that represents the related alarm.
$ref: "SOL005_def.yaml#/definitions/Link"
$ref: "SOL005_def.yaml#/definitions/NotificationLink"
AlarmListRebuiltNotification:
description: >
......@@ -221,11 +221,11 @@ definitions:
subscription:
description: >
Link to the related subscription.
$ref: "SOL005_def.yaml#/definitions/Link"
$ref: "SOL005_def.yaml#/definitions/NotificationLink"
alarms:
description: >
Link to the alarm list, i.e. the "Alarms" resource.
$ref: "SOL005_def.yaml#/definitions/Link"
$ref: "SOL005_def.yaml#/definitions/NotificationLink"
AlarmModifications:
description: >
......@@ -345,7 +345,8 @@ definitions:
$ref: "#/definitions/PerceivedSeverityType"
eventTypes:
description: >
Match VNF alarms with an event type listed in this attribute.
Match VNF alarms related to NSs with an event type listed
in this attribute.
type: array
items:
$ref: "#/definitions/EventType"
......@@ -534,7 +535,7 @@ definitions:
subscription:
description: >
Link to the related subscription.
$ref: "SOL005_def.yaml#/definitions/Link"
$ref: "SOL005_def.yaml#/definitions/NotificationLink"
alarm:
description: >
Link to the resource that represents the related alarm.
......
src/SOL005/NSLifecycleManagement/NSLifecycleManagement.yaml
View file @ 9f5f89cf
......@@ -27,6 +27,57 @@ produces:
- "application/json"
paths:
###############################################################################
# API Versions #
###############################################################################
'/api-versions':
get:
summary: Retrieve API version information
description: >
The GET method reads API version information. This method shall follow the provisions specified in
table 4.6.3.3.3.2-1 for request and response data structures, and response codes. URI query parameters are not
supported.
parameters:
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
type: string
responses:
200:
description: >
200 OK
API version information was read successfully.
The response body shall contain API version information, as defined in clause 4.4.1.7.
schema:
$ref: '../definitions/SOL005_def.yaml#/definitions/ApiVersionInformation'
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
Version:
description: The used API version.
type: string
maximum: 1
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' }
413: { $ref: '../responses/SOL005_resp.yaml#/responses/413' }
414: { $ref: '../responses/SOL005_resp.yaml#/responses/414' }
416: { $ref: '../responses/SOL005_resp.yaml#/responses/416' }
422: { $ref: '../responses/SOL005_resp.yaml#/responses/422' }
429: { $ref: '../responses/SOL005_resp.yaml#/responses/429' }
500: { $ref: '../responses/SOL005_resp.yaml#/responses/500' }
503: { $ref: '../responses/SOL005_resp.yaml#/responses/503' }
504: { $ref: '../responses/SOL005_resp.yaml#/responses/504' }
###############################################################################
# NSInstances #
###############################################################################
'/ns_instances':
......@@ -57,6 +108,12 @@ paths:
in: header
required: true
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
- name: "body"
in: "body"
required: true
......@@ -100,6 +157,12 @@ paths:
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#/responses/400-attr-selector"
401:
......@@ -129,41 +192,41 @@ paths:
This method shall support the URI query parameters, request and response data structures, and response codes, as
specified in the Tables 6.4.2.3.2-1 and 6.4.2.3.2-2.
parameters:
- name: "filter"
in: "query"
- name: filter
in: query
required: false
type: "string"
type: string
description: >
"Attribute-based filtering parameters according to clause 4.3.2.
The NFVO shall support receiving filtering parameters as part of the URI
query string. The OSS/BSS may supply filtering parameters.
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 NsInstance and in data types
referenced from it shall be supported in attribute-based filtering parameters"
- name: "all_fields"
in: "query"
referenced from it shall be supported by the NFVO in the filter expression.
- name: all_fields
in: query
required: false
type: "string"
type: string
description: >
"Include all complex attributes in the response. See clause 4.3.3 for details.
The NFVO shall support this parameter."
- name: "fields"
in: "query"
Include all complex attributes in the response. See clause 4.3.3 for details.
The NFVO shall support this parameter.
- name: fields
in: query
required: false
type: "string"
type: string
description: >
"Complex attributes to be included into the response. See clause 4.3.3 for
details. The NFVO should support this parameter."
- name: "exclude_fields"
in: "query"
- name: exclude_fields
in: query
required: false
type: "string"
type: string
description: >
"Complex attributes to be excluded from the response. See clause 4.3.3 for
details. The NFVO should support this parameter."
- name: "exclude_default"
in: "query"
- name: exclude_default
in: query
required: false
type: "string"
type: string
description: >
"Indicates to exclude the following complex attributes from the response.
See clause 4.3.3 for details. The NFVO shall support this parameter.
......@@ -177,6 +240,13 @@ paths:
- sapInfo
- nsScaleStatus
- additionalAffinityOrAntiAffinityRules"
- 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.
......@@ -191,16 +261,23 @@ paths:
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
responses:
200:
description: >
200 OK
Information about zero or more NS instances was
queried successfully.
The response body shall contain representations of
zero or more NS instances, as defined in
clause 6.5.2.8.
Information about zero or more NS instances was queried successfully.
The response body shall contain in an array the representations of
zero or more NS instances, as defined in clause 6.5.2.8.
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:
description: The MIME type of the body of the response.
......@@ -215,6 +292,18 @@ paths:
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
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:
......@@ -281,6 +370,12 @@ paths:
in: header
required: true
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
responses:
200:
description: >
......@@ -309,6 +404,12 @@ paths:
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#/responses/400-attr-selector"
401:
......@@ -344,6 +445,12 @@ paths:
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
responses:
204:
description: >
......@@ -361,6 +468,12 @@ paths:
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#/responses/400-attr-selector"
401:
......@@ -420,6 +533,12 @@ paths:
in: header
required: true
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
- name: "body"
in: "body"
required: true
......@@ -494,6 +613,12 @@ paths:
in: header
required: true
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
- name: "body"
in: "body"
required: true
......@@ -567,6 +692,12 @@ paths:
in: header
required: true
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
- name: "body"
in: "body"
required: true
......@@ -642,6 +773,12 @@ paths:
in: header
required: true
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
- name: "body"
in: "body"
required: true
......@@ -721,6 +858,12 @@ paths:
in: header
required: true
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
- name: "body"
in: "body"
required: true
......@@ -769,34 +912,34 @@ paths:
This method shall follow the provisions specified in the Tables 6.4.9.3.2-1 and 6.4.9.3.2-2 for URI query parameters,
request and response data structures, and response codes.
parameters:
- name: "filter"
in: "query"
- name: filter
in: query
required: false
type: "string"
type: string
description: >
Attribute-based filtering parameters according to clause 4.3.2.
The NFVO shall support receiving filtering parameters as part of the URI query string.
The OSS/BSS may supply an attribute filter.
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 NsLcmOpOcc and in data types referenced
from it shall be supported in filtering parameters.
- name: "fields"
in: "query"
from it shall be supported by the NFVO in the filter expression.
- name: fields
in: query
required: false
type: "string"
type: string
description: >
Complex attributes to be included into the response. See clause 4.3.3 for details. The
NFVO should support this parameter.
- name: "exclude_fields"
in: "query"
- name: exclude_fields
in: query
required: false
type: "string"
type: string
description: >
Complex attributes to be excluded from the response. See clause 4.3.3 for details.
The NFVO should support this parameter.
- name: "exclude_default"
in: "query"
- name: exclude_default
in: query
required: false
type: "string"
type: string
description: >
Indicates to exclude the following complex attributes from the response. See
clause 4.3.3 for details. The NFVO shall support this parameter.
......@@ -806,6 +949,13 @@ paths:
- changedVnfInfo
- error
- resourceChanges
- 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.
......@@ -820,16 +970,24 @@ paths:
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
responses:
200:
description: >
200 OK
Status information for zero or more NS lifecycle
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.
Status information for zero or more NS lifecycle management operation
occurrences was queried successfully.
The response body shall contain in an array the representations of
zero or more NS instances, as defined in clause 5.5.2.13.
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:
description: The MIME type of the body of the response.
......@@ -844,6 +1002,18 @@ paths:
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
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:
......@@ -912,15 +1082,21 @@ paths:
in: header
required: true
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
responses:
200:
description: >
200 OK
Information about an individual NS instance was queried successfully.
The response body shall contain status information
about a NS lifecycle management operation
occurrence (see clause 6.5.2.3).
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).
schema:
type: "object"
properties:
......@@ -942,6 +1118,12 @@ paths:
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#/responses/400"
401:
......@@ -996,6 +1178,12 @@ paths:
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
responses:
202:
$ref: "responses/SOL005_resp.yaml#/responses/202"
......@@ -1051,6 +1239,12 @@ paths:
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
responses:
202:
$ref: "responses/SOL005_resp.yaml#/responses/202"
......@@ -1100,6 +1294,12 @@ paths:
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
responses:
202:
$ref: "responses/SOL005_resp.yaml#/responses/202"
......@@ -1161,6 +1361,12 @@ paths:
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
responses:
200:
description: 200 OK
......@@ -1191,6 +1397,12 @@ paths:
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#/responses/400"
401:
......@@ -1258,6 +1470,12 @@ paths:
in: header
required: true
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
- name: "body"
in: "body"
required: true
......@@ -1360,6 +1578,12 @@ paths:
in: header
required: true
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
- name: "body"
in: "body"
required: true
......@@ -1402,6 +1626,12 @@ paths:
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
303:
description: >
See Other.
......@@ -1422,6 +1652,12 @@ paths:
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#/responses/400"
401:
......@@ -1447,6 +1683,23 @@ paths:
functional block that invokes the method. It can be used e.g. for
resynchronization after error situations.
parameters:
- 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.
......@@ -1461,15 +1714,23 @@ paths:
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
responses:
200:
description: >
200 OK
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.
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"
......@@ -1485,7 +1746,18 @@ paths:
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
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:
......@@ -1564,6 +1836,12 @@ paths:
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
responses:
200:
description: >
......@@ -1591,6 +1869,12 @@ paths:
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#/responses/400"
401:
......@@ -1621,6 +1905,12 @@ paths:
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
responses:
204:
description: >
......@@ -1637,6 +1927,12 @@ paths:
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#/responses/400"
401:
......@@ -1698,6 +1994,12 @@ paths:
in: header
required: true
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
responses:
204:
description: >
......@@ -1713,6 +2015,12 @@ paths:
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#/responses/400-attr-selector"
401:
......@@ -1775,6 +2083,12 @@ paths:
in: header
required: true
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
responses:
204:
description: >
......@@ -1790,6 +2104,12 @@ paths:
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#/responses/400-attr-selector"
401:
......@@ -1852,6 +2172,12 @@ paths:
in: header
required: true
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
responses:
204:
description: >
......@@ -1867,6 +2193,12 @@ paths:
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#/responses/400-attr-selector"
401:
......@@ -1911,6 +2243,12 @@ paths:
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
responses:
204:
description: >
......@@ -1927,6 +2265,12 @@ paths:
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#/responses/400-attr-selector"
401:
......
src/SOL005/NSLifecycleManagement/definitions/NSLifecycleManagement_def.yaml
View file @ 9f5f89cf
......@@ -35,7 +35,6 @@ definitions:
- lcmOperationType
- startTime
- isAutomaticInvocation
- operationParams
- isCancelPending
- _links
properties:
......@@ -86,6 +85,11 @@ definitions:
- UPDATE: UpdateNsRequest
- HEAL: HealNsRequest
- TERMINATE: TerminateNsRequest
This attribute shall be present if this data type is returned
in a response to reading an individual resource, and may
be present according to the chosen attribute selector
parameter if this data type is returned in a response to a
query of a container resource.
type: string
enum:
- INSTANTIATE
......
src/SOL005/NSLifecycleManagement/definitions/SOL005NSLifecycleManagement_def.yaml
View file @ 9f5f89cf
......@@ -112,6 +112,14 @@ definitions:
enum:
- NOT_INSTANTIATED
- INSTANTIATED
monitoringParameter:
description: >
Performance metrics tracked by the NFVO (e.g. for
auto-scaling purposes) as identified by the NS
designer in the NSD.
type: array
items:
$ref: "#/definitions/NsMonitoringParameter"
nsScaleStatus:
description: >
Status of each NS scaling aspect declared in the
......@@ -307,32 +315,7 @@ definitions:
type: array
minItems: 1
items:
type: object
required:
- id
- cpdId
properties:
id:
description: >
Identifier of the external CP instance and the related information instance.
$ref: "SOL005_def.yaml#/definitions/IdentifierInVnf"
cpdId:
description: >
Identifier of the external CPD, VnfExtCpd, in the VNFD.
$ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd"
cpProtocolInfo:
description: >
Network protocol information for this CP.
type: array
items:
$ref: "#/definitions/CpProtocolInfo"
extLinkPortId:
description: >
Identifier of the "extLinkPortInfo" structure inside the the
"extVirtualLinkInfo" structure. Shall be present if the CP is
associated to a link port.
$ref: "SOL005_def.yaml#/definitions/Identifier"
$ref: "#/definitions/VnfExtCpInfo"
extVirtualLinkInfo:
description: >
Information about the external VLs the VNF instance is connected to.
......@@ -347,10 +330,12 @@ definitions:
$ref: "#/definitions/ExtManagedVirtualLinkInfo"
monitoringParameters:
description: >
Active monitoring parameters.
Performance metrics tracked by the VNFM (e.g. for
auto-scaling purposes) as identified by the VNF
provider in the VNFD.
type: array
items:
$ref: "#/definitions/MonitoringParameter"
$ref: "#/definitions/VnfMonitoringParameter"
localizationLanguage:
description: >
Information about localization language of the VNF (includes e.g.
......@@ -404,17 +389,17 @@ definitions:
description: >
Link to the resource representing the NS instance to
which the notified change applies..
$ref: "SOL005_def.yaml#/definitions/Link"
$ref: "SOL005_def.yaml#/definitions/NotificationLink"
subscription:
description: >
Link to the subscription that triggered this notification.
$ref: "SOL005_def.yaml#/definitions/Link"
lcOpOcc:
$ref: "SOL005_def.yaml#/definitions/NotificationLink"
nslcmOpOcc:
description: >
Link to the lifecycle operation occurrence that this
notification is related to. Shall be present if there is a
related lifecycle operation occurrence
$ref: "SOL005_def.yaml#/definitions/Link"
$ref: "SOL005_def.yaml#/definitions/NotificationLink"
Version:
description: >
......@@ -517,6 +502,7 @@ definitions:
required:
- id
- nsVirtualLinkDescId
- nsVirtualLinkProfileId
properties:
id:
description: >
......@@ -526,6 +512,10 @@ definitions:
description: >
Identifier of the VLD in the NSD.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
nsVirtualLinkProfileId:
description: >
Identifier of the VL profile in the NSD.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
resourceHandle:
description: >
Identifier(s) of the virtualised network resource(s)
......@@ -589,6 +579,63 @@ definitions:
items:
$ref: "#/definitions/NsCpHandle"
NfpInfo:
description: >
This type represents an NFP instance. It shall comply with
the provisions defined in Table 6.5.3.66-1.
type: object
required:
- id
- nfpRule
- nfpState
properties:
id:
description: >
Identifier of this NFP instance.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNs"
nfpdId:
description: >
Identifier of the NFPD used to instantiate this NFP
instance. It shall be present if the NFP instance is
instantiated from the NFPD.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
nfpName:
description: >
Human readable name for the NFP instance.
type: string
description:
description: >
Human readable description for the NFP instance.
type: string
cpGroup:
description: >
Group(s) of CPs and/or SAPs which the NFP passes through.
When multiple identifiers are included, the position of
the identifier in the CpGroup data type specifies the
position of the group in the path.
type: array
minItems: 1
items:
$ref: "#/definitions/NsCpHandle"
totalCp:
description: >
Total number of CP and SAP instances in this NFP instance.
type: integer
nfpRule:
description: >
NFP classification and selection rule.
$ref: "#/definitions/NfpRule"
nfpState:
description: >
The state of the NFP instance.
Permitted values:
* ENABLED: The NFP instance is enabled.
* DISABLED: The NFP instance is disabled.
type: string
enum:
- ENABLED
- DISABLED
NsCpHandle:
description: >
This type represents an identifier of the CP or SAP instance.
......@@ -665,6 +712,212 @@ definitions:
items:
$ref: "#/definitions/CpProtocolInfo"
NsMonitoringParameter:
description: >
This type represents a monitoring parameter that is tracked by the NFVO, for example,
for auto-scaling purposes. It shall comply with the provisions defined in Table 6.5.3.68-1.
type: object
required:
- id
- performanceMetric
properties:
id:
description: >
Identifier of the monitoring parameter defined in the NSD.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
name:
description: >
Human readable name of the monitoring parameter, as defined in the NSD.
type: string
performanceMetric:
description: >
Performance metric that is monitored. This attribute shall contain the related
"Measurement Name" value as defined in clause 7.2 of ETSI GS NFV-IFA 027.
type: string
VnfMonitoringParameter:
description: >
This type represents a monitoring parameter that is tracked by the VNFM, for example,
for auto-scaling purposes. It shall comply with the provisions defined in Table 6.5.3.69-1.
type: object
required:
- id
- performanceMetric
properties:
id:
description: >
Identifier of the monitoring parameter defined in the VNFD.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
name:
description: >
Human readable name of the monitoring parameter, as defined in the VNFD.
type: string
performanceMetric:
description: >
Performance metric that is monitored. This attribute shall contain the related
"Measurement Name" value as defined in clause 7.2 of ETSI GS NFV-IFA 027.
type: string
VnfExtCpInfo:
description: >
This type represents information about an external CP of a VNF. It shall comply
with the provisions defined in Table 6.5.3.70-1.
type: object
required:
- id
- cpdId
properties:
id:
description: >
Identifier of the external CP instance and the related information instance.
$ref: "SOL005_def.yaml#/definitions/IdentifierInVnf"
cpdId:
description: >
Identifier of the external CPD, VnfExtCpd, in the VNFD.
$ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd"
cpProtocolInfo:
description: >
Network protocol information for this CP.
type: array
minItems: 1
items:
$ref: "SOL005_def.yaml#/definitions/CpProtocolInfo"
extLinkPortId:
description: >
Identifier of the "extLinkPortInfo" structure inside the "extVirtualLinkInfo"
structure. Shall be present if the CP is associated to a link port.
$ref: "#/definitions/CpProtocolInfo"
metadata:
description: >
Metadata about this external CP.
$ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
associatedVnfcCpId:
description: >
Identifier of the "vnfcCpInfo" structure in "VnfcResourceInfo" structure
that represents the VNFC CP which is exposed by this external CP instance.
Shall be present in case this CP instance maps to a VNFC CP(s).
The attributes "associatedVnfcCpId" and "associatedVnfVirtualLinkId" are
mutually exclusive. One and only one shall be present.
$ref: "SOL005_def.yaml#/definitions/IdentifierInVnf"
associatedVnfVirtualLinkId:
description: >
Identifier of the "VnfVirtualLinkResourceInfo" structure that represents
the internal VL, which is exposed by this external CP instance. Shall be
present in case this CP instance maps to an internal VL.
The attributes "associatedVnfcCpId" and "associatedVnfVirtualLinkId" are
mutually exclusive. One and only one shall be present.
$ref: "SOL005_def.yaml#/definitions/IdentifierInVnf"
CpGroupInfo:
description: >
This type represents describes a group of CPs and/or SAPs pairs associated to
the same position in an NFP. It shall comply with the provisions defined in
Table 6.5.3.71-1.
type: object
properties:
cpPairInfo:
description: >
One or more pair(s) of ingress and egress CPs or SAPs which the NFP passes by.
All CP or SAP pairs in a group shall be instantiated from connection point
descriptors or service access point descriptors referenced in the corresponding
NfpPositionDesc.
type: array
minItems: 1
items:
$ref: "#/definitions/CpPairInfo"
forwardingBehaviour:
description: >
Identifies a rule to apply to forward traffic to the ingress CPs or SAPs of
the group.
Permitted values:
* ALL = Traffic flows shall be forwarded simultaneously to all CPs or SAPs
of the group.
* LB = Traffic flows shall be forwarded to one CP or SAP of the group selected
based on a loadbalancing algorithm.
type: string
enum:
- ALL
- LB
forwardingBehaviourInputParameters:
description: >
Provides input parameters to configure the forwarding behaviour (e.g. identifies
a load balancing algorithm and criteria).
$ref: "#/definitions/ForwardingBehaviourInputParameters"
cpPairInfo:
description: >
This type represents describes a pair of ingress and egress CPs or SAPs which
the NFP passes by. It shall comply with the provisions defined in Table 6.5.3.72-1.
type: object
properties:
vnfExtCpIds:
description: >
Identifier(s) of the VNF CP(s) which form the pair.
The presence of a single vnfExpCpId, pnfExtCpId, or sapId occurrence indicates
that the CP or SAP is used both as an ingress and egress port at a particular
NFP position.
type: array
maxItems: 2
items:
$ref: "SOL005_def.yaml#/definitions/IdentifierInVnf"
pnfExtCpIds:
description: >
Identifier(s) of the PNF CP(s) which form the pair.
The presence of a single vnfExpCpId, pnfExtCpId, or sapId occurrence indicates
that the CP or SAP is used both as an ingress and egress port at a particular
NFP position.
type: array
maxItems: 2
items:
$ref: "SOL005_def.yaml#/definitions/IdentifierInPnf"
sapIds:
description: >
Identifier(s) of the SAP(s) which form the pair.
The presence of a single vnfExpCpId, pnfExtCpId, or sapId occurrence indicates
that the CP or SAP is used both as an ingress and egress port at a particular
NFP position.
type: array
maxItems: 2
items:
$ref: "SOL005_def.yaml#/definitions/IdentifierInNs"
ForwardingBehaviourInputParameters:
description: >
This type represents provides input parameters to configure the forwarding behaviour.
It shall comply with the provisions defined in Table 6.5.3.73-1.
type: object
properties:
algortihmName:
description: >
May be included if forwarding behaviour is equal to LB. Shall not be included otherwise.
Permitted values:
* ROUND_ROBIN
* LEAST_CONNECTION
* LEAST_TRAFFIC
* LEAST_RESPONSE_TIME
* CHAINED_FAILOVER
* SOURCE_IP_HASH
* SOURCE_MAC_HASH
type: string
enum:
- ROUND_ROBIN
- LEAST_CONNECTION
- LEAST_TRAFFIC
- LEAST_RESPONSE_TIME
- CHAINED_FAILOVER
- SOURCE_IP_HASH
- SOURCE_MAC_HASH
algorithmWeights:
description: >
Percentage of messages sent to a CP instance. May be included if applicable to
the algorithm.
If applicable to the algorithm but not provided, default values determined by
the VIM or NFVI are expected to be used.
Weight applies to the CP instances in the order they have been created.
type: array
items:
type: integer
CpProtocolInfo:
description: >
This type describes the protocol layer(s) that a CP or SAP uses together with protocol-related information, like
......@@ -929,6 +1182,18 @@ definitions:
The value refers to an "extCpInfo" item in the VnfInstance or a
"vnfcCpInfo" item of a "vnfcResouceInfo" item in the VnfInstance.
$ref: "SOL005_def.yaml#/definitions/IdentifierInVnf"
cpInstanceType:
description: >
Type of the CP instance that is identified by cpInstanceId.
Shall be present if "cpInstanceId" is present, and shall be
absent otherwise.
Permitted values:
* VNFC_CP: The link port is connected to a VNFC CP
* EXT_CP: The link port is associated to an external CP.
type: string
enum:
- VNFC_CP
- EXT_CP
MonitoringParameter:
type: object
......@@ -1030,9 +1295,13 @@ definitions:
vnfLinkPortId:
description: >
Identifier of the "vnfLinkPorts" structure in the
"vnfVirtualLinkResourceInfo" structure. Shall be present if
"VnfVirtualLinkResourceInfo" structure. Shall be present if
the CP is associated to a link port.
$ref: "SOL005_def.yaml#/definitions/IdentifierInVnf"
metadata:
description: >
Metadata about this CP.
$ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
metadata:
description: >
Metadata about this resource.
......@@ -1238,16 +1507,26 @@ definitions:
Specify an existing VNF instance to be used in the NS.
If needed, the VNF Profile to be used for this VNF
instance is also provided.
The DF of the VNF instance shall match the VNF DF
present in the associated VNF Profile.
type: array
items:
$ref: "#/definitions/VnfInstanceData"
nestedNsInstanceId:
nestedNsInstanceData:
description: >
Specify an existing NS instance to be used as a nested
NS within the NS.
If needed, the NS Profile to be used for this nested NS
instance is also provided.
NOTE 2: The NS DF of each nested NS shall be one of the
allowed flavours in the associated NSD (as referenced in the
nestedNsd attribute of the NSD of the NS to be instantiated).
NOTE 3: The NSD of each referenced NSs (i.e. each
nestedInstanceId) shall match the one of the nested NSD in
the composite NSD.
type: array
items:
$ref: "SOL005_def.yaml#/definitions/Identifier"
$ref: "#/definitions/NestedNsInstanceData"
localizationLanguage:
description: >
Defines the location constraints for the VNF to be
......@@ -1260,17 +1539,33 @@ definitions:
additionalParamsForNs:
description: >
Allows the OSS/BSS to provide additional parameter(s)
at the NS level (as opposed to the VNF level, which is
covered in additionalParamsForVnf)..
at the composite NS level (as opposed to the VNF level,
which is covered in additionalParamsForVnf), and as
opposed to the nested NS level, which is covered in
additionalParamForNestedNs.
$ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
additionalParamsForVnf:
additionalParamForNestedNs:
description: >
Allows the OSS/BSS to provide additional parameter(s)
per VNF instance (as opposed to the NS level, which is
covered in additionalParamsForNs). This is for VNFs
per nested NS instance (as opposed to the composite NS
level, which is covered in additionalParamForNs, and as
opposed to the VNF level, which is covered in
additionalParamForVnf). This is for nested NS instances
that are to be created by the NFVO as part of the NS
instantiation and not for existing VNF that are
referenced for reuse..
instantiation and not for existing nested NS instances that
are referenced for reuse.
type: array
items:
$ref: "#/definitions/ParamsForNestedNs"
additionalParamsForVnf:
description: >
Allows the OSS/BSS to provide additional parameter(s)
per VNF instance (as opposed to the composite NS level,
which is covered in additionalParamsForNs and as opposed
to the nested NS level, which is covered in
additionalParamForNestedNs). This is for VNFs that are
to be created by the NFVO as part of the NS instantiation
and not for existing VNF that are referenced for reuse.
type: array
items:
$ref: "#/definitions/ParamsForVnf"
......@@ -1286,7 +1581,7 @@ definitions:
default NS instantiation level as declared in the NSD
shall be used.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
additionalAffinityOrAntiAffiniityRule:
additionalAffinityOrAntiAffinityRule:
description: >
Specifies additional affinity or anti-affinity constraint for
the VNF instances to be instantiated as part of the NS
......@@ -1296,6 +1591,26 @@ definitions:
items:
$ref: "#/definitions/AffinityOrAntiAffinityRule"
ParamsForNestedNs:
description: >
This type specifies additional parameters on a per-nested NS instance basis.
It shall comply with the provisions defined in Table 6.5.3.21a-1.
type: object
required:
- nsProfileId
properties:
nsProfileId:
description: >
Identifier of a NsProfile to which the additional parameters apply.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
additionalParam:
description: >
Additional parameters that are to be applied on a per nested NS instance.
type: array
items:
$ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
ParamsForVnf:
description: >
This type defines the additional parameters for the VNF instance
......@@ -1395,6 +1710,27 @@ definitions:
matching the information in the VNF instance.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
NestedNsInstanceData:
description: >
This type specifies an existing nested NS instance to be used in the NS instance
and if needed, the NsProfile to use for this nested NS instance.
It shall comply with the provisions defined in Table 6.5.3.19a-1.
type: object
required:
- nestedNsInstanceId
properties:
nestedNsInstanceId:
description: >
Identifier of the existing nested NS instance to be used in the NS.
$ref: "SOL005_def.yaml#/definitions/Identifier"
nsProfileId:
description: >
Identifier of an NsProfile defined in the NSD which the existing
nested NS instance shall be matched with.
If not present, the NFVO will select the NsProfile matching the
information in the nested NS instance.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNs"
SapData:
description: >
This type represents the information related to a SAP of a NS.
......@@ -1593,14 +1929,14 @@ definitions:
type: array
items:
$ref: "SOL005_def.yaml#/definitions/Identifier"
addNestedNsId:
addNestedNsData:
description: >
The identifier of an existing nested NS instance to be
added to (nested within) the NS instance. It shall be
present only if updateType = "ADD_NESTED_NS".
type: array
items:
$ref: "SOL005_def.yaml#/definitions/Identifier"
$ref: "#/definitions/NestedNsInstanceData"
removeNestedNsId:
description: >
The identifier of an existing nested NS instance to be
......@@ -2036,26 +2372,36 @@ definitions:
description: >
Identifier of the NFP to be modified. It shall be present
for modified NFPs and shall be absent for the new NFP.
It shall be present for modified NFPs and shall be absent
for the new NFP.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNs"
nfpName:
description: >
Human readable name for the NFP. It shall be present
for the new NFP, and it may be present otherwise.
It shall be present for the new NFP, and it may be
present otherwise.
type: string
description:
description: >
Human readable description for the NFP. It shall be
present for the new NFP, and it may be present otherwise.
It shall be present for the new NFP, and it may be
present otherwise.
type: string
nsCpHandle:
cpGroup:
description: >
Identifier(s) of the CPs and SAPs which the NFP passes by.
Group(s) of CPs and/or SAPs which the NFP passes by.
Cardinality can be 0 if only updated or newly created
NFP classification and selection rule which applied to an
existing NFP is provided.
At least a CP or an nfpRule shall be present.
When multiple identifiers are included, the position of
the identifier in the cpGroup value specifies the position
of the group in the path.
type: array
items:
$ref: "#/definitions/NsCpHandle"
$ref: "#/definitions/CpGroupInfo"
nfpRule:
description: >
NFP classification and selection rule. See note 1.
......
src/SOL005/NSLifecycleManagement/definitions/SOL005_def.yaml
View file @ 9f5f89cf
......@@ -355,13 +355,13 @@ definitions:
The identifier of the externally-managed internal VL
instance, if provided.
$ref: "#/definitions/Identifier"
virtualLinkDescId:
vmfVirtualLinkDescId:
description: >
The identifier of the VLD in the VNFD for this VL.
$ref: "#/definitions/IdentifierInVnfd"
vimId:
description: >
Identifier of the VIMthat manage this resource. This
Identifier of the VIM that manage this resource. This
attribute shall only be supported and present if VNFrelated
resource management in direct mode is applicable.
$ref: "#/definitions/Identifier"
......
src/SOL005/VNFPackageManagement/VNFPackageManagement.yaml
View file @ 9f5f89cf
......@@ -27,6 +27,57 @@ produces:
- "application/json"
paths:
###############################################################################
# API Versions #
###############################################################################
'/api-versions':
get:
summary: Retrieve API version information
description: >
The GET method reads API version information. This method shall follow the provisions specified in
table 4.6.3.3.3.2-1 for request and response data structures, and response codes. URI query parameters are not
supported.
parameters:
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: false
type: string
responses:
200:
description: >
200 OK
API version information was read successfully.
The response body shall contain API version information, as defined in clause 4.4.1.7.
schema:
$ref: '../definitions/SOL005_def.yaml#/definitions/ApiVersionInformation'
headers:
Content-Type:
description: The MIME type of the body of the response.
type: string
maximum: 1
minimum: 1
Version:
description: The used API version.
type: string
maximum: 1
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' }
413: { $ref: '../responses/SOL005_resp.yaml#/responses/413' }
414: { $ref: '../responses/SOL005_resp.yaml#/responses/414' }
416: { $ref: '../responses/SOL005_resp.yaml#/responses/416' }
422: { $ref: '../responses/SOL005_resp.yaml#/responses/422' }
429: { $ref: '../responses/SOL005_resp.yaml#/responses/429' }
500: { $ref: '../responses/SOL005_resp.yaml#/responses/500' }
503: { $ref: '../responses/SOL005_resp.yaml#/responses/503' }
504: { $ref: '../responses/SOL005_resp.yaml#/responses/504' }
###############################################################################
# VNF Packages #
###############################################################################
'/vnf_packages':
......@@ -39,41 +90,41 @@ paths:
Tables 9.4.2.3.2-1 and 9.4.2.3.2-2 for URI query parameters,
request and response data structures, and response codes.
parameters:
- name: "filter"
in: "query"
- name: filter
in: query
required: false
type: "string"
type: string
description: >
Attribute-based filtering parameters according to clause 4.3.2.
The NFVO shall support receiving filtering parameters as part of the URI query string. The
OSS/BSS may supply filtering parameters.
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 VnfPkgInfo and in data types referenced from it shall
be supported in attribute-based filtering parameters.
- name: "all_fields"
in: "query"
be supported by the NFVO in the filter expression.
- name: all_fields
in: query
required: false
type: "string"
type: string
description: >
Include all complex attributes in the response. See clause 4.3.3 for details. The NFVO
shall support this parameter.
- name: "fields"
in: "query"
- name: fields
in: query
required: false
type: "string"
type: string
description: >
Complex attributes to be included into the response. See clause 4.3.3 for details. The
NFVO should support this parameter.
- name: "exclude_fields"
in: "query"
- name: exclude_fields
in: query
required: false
type: "string"
type: string
description: >
Complex attributes to be excluded from the response. See clause 4.3.3 for details. The
NFVO should support this parameter.
- name: "exclude_default"
in: "query"
- name: exclude_default
in: query
required: false
type: "string"
type: string
description: >
Indicates to exclude the following complex attributes from the response. See clause 4.3.3
for details.
......@@ -85,6 +136,13 @@ paths:
- additionalArtifacts
- userDefinedData
- checksum
- 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.
......@@ -99,12 +157,24 @@ paths:
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
responses:
200:
description: >
200 OK
Information of the selected VNF packages.
Information about zero or more VNF packages was successfully queried.
The response body shall contain in an array the VNF package info
representations that match the attribute filter, i.e., zero or more
VNF package info representations as defined in clause 9.5.2.5.
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:
description: The MIME type of the body of the response.
......@@ -119,6 +189,18 @@ paths:
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
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:
......@@ -170,6 +252,12 @@ paths:
in: header
required: true
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
- name: "body"
in: "body"
required: true
......@@ -216,6 +304,12 @@ paths:
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
###############################################################################
# Individual VNF Package #
###############################################################################
......@@ -247,12 +341,20 @@ paths:
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
responses:
200:
description: >
200 OK
Information of the VNF package.
Information of the VNF package was read successfully.
The response body shall contain the VNF package
info representation defined in clause 9.5.2.5.
schema:
type: "object"
properties:
......@@ -272,6 +374,12 @@ paths:
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#/responses/400"
401:
......@@ -302,6 +410,12 @@ paths:
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
responses:
204:
description: >
......@@ -364,6 +478,12 @@ paths:
in: header
required: true
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
responses:
200:
description: >
......@@ -387,6 +507,12 @@ paths:
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
schema:
properties:
VnfPkgInfoModifications:
......@@ -420,7 +546,7 @@ paths:
parameters:
- name: vnfPkgId
description: >
Identifier of the on-boarded VNF package. The identifier is allocated by the NFVO.
Identifier of the VNF package. The identifier is allocated by the NFVO.
in: path
type: string
required: true
......@@ -461,6 +587,12 @@ paths:
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
responses:
200:
description: >
......@@ -488,6 +620,12 @@ paths:
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#/responses/400"
401:
......@@ -523,7 +661,7 @@ paths:
parameters:
- name: "vnfPkgId"
description: >
Identifier of the on-boarded VNF package. The identifier is allocated by the NFVO.
Identifier of the VNF package. The identifier is allocated by the NFVO.
in: "path"
required: true
type: "string"
......@@ -560,6 +698,12 @@ paths:
If the NFVO does not support range requests, it should return the
whole file with a 200 OK response instead.
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
responses:
200:
description: >
......@@ -585,6 +729,12 @@ paths:
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:
$ref: "responses/SOL005_resp.yaml#/responses/206"
409:
......@@ -643,6 +793,12 @@ paths:
The "Content-Type" HTTP header shall be set according to the
type of the file, i.e. to "application/zip" for a VNF Package as
defined in ETSI GS NFV-SOL 004 [5].
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
responses:
202:
description: >
......@@ -727,6 +883,12 @@ paths:
description: >
The payload body contains the address information based on
which the NFVO can obtain the content of the VNF package.
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
responses:
202:
......@@ -764,7 +926,7 @@ paths:
parameters:
- name: vnfPkgId
description: >
Identifier of the on-boarded VNF package.
Identifier of the VNF package.
The identifier is allocated by the NFVO.
This identifier can be retrieved from the "vnfPkgId" attribute in the VnfPackageOnboardingNotification or
VnfPackageChangeNotification.
......@@ -773,10 +935,13 @@ paths:
required: true
- name: artifactPath
description: >
Path of the artifact within the VNF package.
This identifier can be retrieved from the "artifactPath" attribute of the applicable "additionalArtifacts" entry in
the body of the response to a GET request querying the "Individual VNF package" or the "VNF packages"
resource.
Sequence of one or path segments representing the path of the artifact
within the VNF package.
EXAMPLE: foo/bar/run.sh
This identifier can be retrieved from the "artifactPath" attribute of
the applicable "additionalArtifacts" entry in the body of the response
to a GET request querying the "Individual VNF package" or the
"VNF packages" resource.
in: path
type: string
required: true
......@@ -810,6 +975,12 @@ paths:
whole file with a 200 OK response instead.
in: header
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
responses:
200:
description: >
......@@ -835,6 +1006,12 @@ paths:
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: >
......@@ -866,6 +1043,12 @@ paths:
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#/responses/400"
401:
......@@ -926,6 +1109,12 @@ paths:
in: header
required: true
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
- name: "body"
in: "body"
required: true
......@@ -963,6 +1152,12 @@ paths:
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
schema:
type: array
items:
......@@ -998,16 +1193,23 @@ paths:
Tables 9.4.7.8.2-1 and 9.4.8.3.2-2 for URI query parameters,
request and response data structures, and response codes.
parameters:
- name: "filter"
in: "query"
- name: filter
in: query
required: false
type: "string"
type: string
description: >
Attribute-based filtering parameters according to clause 4.3.2.
The NFVO shall support receiving filtering parameters as part of the URI query
string. The OSS/BSS may supply filtering parameters.
Attribute-based filtering expression according to clause 4.3.2.
The NFVO shall support receiving this filtering parameter as part of the URI query
string. The OSS/BSS may supply this filtering parameter.
All attribute names that appear in the PkgmSubscription and in data types
referenced from it shall be supported in attribute-based filtering parameters
referenced from it shall be supported by the NFVO in the filtering 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.
......@@ -1022,6 +1224,12 @@ paths:
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
responses:
200:
description: >
......@@ -1042,6 +1250,18 @@ paths:
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
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:
......@@ -1103,6 +1323,12 @@ paths:
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
responses:
200:
description: >
......@@ -1123,6 +1349,12 @@ paths:
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
schema:
properties:
PkgmSubscription:
......@@ -1157,6 +1389,12 @@ paths:
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
responses:
204:
description: >
......@@ -1172,6 +1410,12 @@ paths:
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#/responses/400"
401:
......@@ -1236,6 +1480,12 @@ paths:
in: header
required: true
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
responses:
204:
description: >
......@@ -1251,6 +1501,12 @@ paths:
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#/responses/400"
401:
......@@ -1302,6 +1558,12 @@ paths:
in: header
required: true
type: string
- name: Version
description: >
Version of the API requested to use when responding to this request.
in: header
required: true
type: string
responses:
204:
description: >
......@@ -1317,6 +1579,12 @@ paths:
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#/responses/400"
401:
......@@ -1350,6 +1618,12 @@ paths:
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
responses:
204:
description: >
......
src/SOL005/VNFPackageManagement/definitions/SOL005VNFPMManagement_def.yaml
View file @ 9f5f89cf
......@@ -147,11 +147,11 @@ definitions:
Link to the resource representing the VNF package to
which the notified change applies, i.e. the individual on boarded
VNF package resource that represents the VNF package.
$ref: "SOL005_def.yaml#/definitions/Link"
$ref: "SOL005_def.yaml#/definitions/NotificationLink"
subscription:
description: >
Link to the related subscription.
$ref: "SOL005_def.yaml#/definitions/Link"
$ref: "SOL005_def.yaml#/definitions/NotificationLink"
VnfPackageSoftwareImageInfo:
description: >
......@@ -537,6 +537,7 @@ definitions:
required:
- id
- notificationType
- subscriptionId
- timeStamp
- vnfPkgId
- vnfdId
......@@ -564,7 +565,7 @@ definitions:
$ref: "SOL005_def.yaml#/definitions/DateTime"
vnfPkgId:
description: >
Identifier of the on-boarded VNF package. This identifier
Identifier of the VNF package. This identifier
is allocated by the NFVO.
Its value is the same as the value of the "id" attribute of
the related "Individual VNF package" resource.
......@@ -596,6 +597,7 @@ definitions:
required:
- id
- notificationType
- subscriptionId
- timeStamp
- vnfPkgId
- vnfdId
......