Skip to content

GitLab

Commit dfc267e6 authored by Francesca Moscatelli's avatar Francesca Moscatelli
Browse files

SOL002: v2.8.1 review fixes

parent cd64ba82
Hide whitespace changes
Inline Side-by-side
Showing with 68 additions and 69 deletions
src/SOL002/VNFConfiguration/VNFConfiguration.yaml
View file @ dfc267e6
......@@ -60,7 +60,7 @@ paths:
get:
summary: Read VNF/VNFC configuration from VNF
description: >
The client can use this method to read configuration information about a VNF instance and/or its VNFC instances.
The API consumer can use this method to read configuration information about a VNF instance and/or its VNFC instances.
responses:
200:
description: >
......
src/SOL002/VNFFaultManagement/VNFFaultManagement.yaml
View file @ dfc267e6
......@@ -60,7 +60,7 @@ paths:
type: string
get:
description: >
The client can use this method to retrieve information about the alarm
The API consumer can use this method to retrieve information about the alarm
list.
parameters:
- name: Accept
......@@ -218,7 +218,7 @@ paths:
type: string
get:
description: >
The client can use this method to read an individual alarm.
The API consumer can use this method to read an individual alarm.
parameters:
- name: Accept
description: >
......@@ -602,8 +602,8 @@ paths:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
get:
description: >
The client can use this method to retrieve the list of active
subscriptions for VNF alarms subscribed by the client. It can be used
The API consumer can use this method to retrieve the list of active
subscriptions for VNF alarms subscribed by the API consumer. It can be used
e.g. for resynchronization after error situations.
parameters:
- name: Accept
......@@ -759,8 +759,8 @@ paths:
type: string
get:
description: >
The client can use this method for reading an individual subscription
for VNF alarms subscribed by the client.
The API consumer can use this method for reading an individual subscription
for VNF alarms subscribed by the API consumer.
parameters:
- name: Accept
description: >
......
src/SOL002/VNFFaultManagement/definitions/SOL002VNFFaultManagement_def.yaml
View file @ dfc267e6
......@@ -28,7 +28,9 @@ definitions:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/Identifier"
vnfcInstanceIds:
description: >
Identifiers of the affected VNFC instances.
Identifiers of the affected VNFC instances. Each identifier references the "id"
attribute in a "VnfcInfo" structure. Shall be present if the alarm affects at
least one VNFC instance.
type: array
items:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
......
src/SOL002/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml
View file @ dfc267e6
......@@ -113,7 +113,7 @@ paths:
get:
description: >
The GET method allows the API producer to test the notification endpoint
that is provided by the client, e.g. during subscription.
that is provided by the API consumer, e.g. during subscription.
responses:
204:
description: >
......@@ -230,8 +230,8 @@ paths:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
get:
description: >
The GET method allows the server to test the notification endpoint
that is provided by the client, e.g. during subscription.
The GET method allows the API producer to test the notification endpoint
that is provided by the API consumer, e.g. during subscription.
responses:
204:
description: >
......@@ -348,8 +348,8 @@ paths:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
get:
description: >
The GET method allows the server to test the notification endpoint
that is provided by the client, e.g. during subscription.
The GET method allows the API producer to test the notification endpoint
that is provided by the API consumer, e.g. during subscription.
responses:
204:
description: >
......
src/SOL002/VNFIndicator/VNFIndicator.yaml
View file @ dfc267e6
......@@ -653,7 +653,7 @@ paths:
description: >
Service Unavailable
This resource represents an individual subscription. The client can use this resource to
This resource represents an individual subscription. The API consumer can use this resource to
read and to terminate a subscription to notifications related to VNF indicator value changes.
parameters:
- name: subscriptionId
......
src/SOL002/VNFIndicatorNotification/VNFIndicatorNotification.yaml
View file @ dfc267e6
......@@ -99,7 +99,7 @@ paths:
Service Unavailable
The GET method allows the API producer to test the notification endpoint that is provided
by the client, e.g. during subscription.
by the API consumer, e.g. during subscription.
responses:
204:
description: >
......
src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml
View file @ dfc267e6
......@@ -375,14 +375,9 @@ paths:
504:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
patch:
#SOL003 location: 5.4.3.3.4
#SOL002/SOL003 location: 5.4.3.3.4
description: >
This method modifies an "Individual VNF instance" resource. Changes to
the VNF configurable properties are applied to the configuration in
the VNF instance, and are reflected in the representation of this
resource. Other changes are applied to the VNF instance information
managed by the VNFM, and are reflected in the representation of this
resource
This method modifies an "Individual VNF instance" resource.
parameters:
- name: vnfInfoModifications
description: Input parameters for VNF info modification
......@@ -1450,7 +1445,7 @@ paths:
type: string
get:
description: >
The client can use this method to query status information about
The API consumer can use this method to query status information about
multiple VNF lifecycle management operation occurrences.
parameters:
- name: filter
......@@ -1628,7 +1623,7 @@ paths:
type: string
get:
description: >
The client can use this method to retrieve status information about a
The API consumer can use this method to retrieve status information about a
VNF lifecycle management operation occurrence by reading an "Individual
VNF LCM operation occurrence" resource.
responses:
......
src/SOL002/VNFLifecycleManagement/definitions/SOL002VNFLifecycleManagement_def.yaml
View file @ dfc267e6
......@@ -222,28 +222,30 @@ definitions:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
extensions:
description: >
Additional VNF specific attributes that affect the lifecycle management of this
VNF instance by the VNFM, or the lifecycle management scripts.
These attributes represent values that are stored persistently in the VnfInstance
structure for consumption by the VNFM, or by the lifecycle management scripts
during the execution of VNF lifecycle management operations.
All extensions that are allowed for the VNF are declared in the VNFD. The declaration of
an extension in the VNFD contains information on whether its presence is optional or
required, and optionally can specify an initial value. See note 2 and note 4.
The VNFM shall reject requests to write extension attributes that are not declared in the VNFD
with a "422 Unprocessable entity" error response as defined in clause 6.4 of ETSI GS NFV SOL 013.
Modifying the values of these attributes has no direct effect on the VNF instance;
however, the modified attribute values can be considered during subsequent VNF
lifecycle management operations, which means that the modified values can indirectly
affect the configuration of the VNF instance.
These attributes can be initialized with default values from the VNFD.
These attributes can be modified with values passed in the request structures of certain LCM operations,
such as the InstantiateVnfRequest structure
Additional VNF specific attributes that affect the lifecycle management of this VNF instance.
These attributes represent values that are stored persistently in the VnfInstance structure for
consumption by the VNFM, or by the lifecycle management scripts during the execution of VNF
lifecycle management operations.
All extensions that are allowed for the VNF are declared in the VNFD. The declaration of an extension
in the VNFD contains information on whether its presence is optional or required, and optionally can
specify an initial value. See note 2 and note 4. The VNFM shall reject requests to write extension
attributes that are not declared in the VNFD with a "422 Unprocessable entity" error response as defined
in clause 6.4 of ETSI GS NFV SOL 013.
Modifying the values of these attributes has no direct effect on the VNF instance; however, the modified
attribute values can be considered during subsequent VNF lifecycle management operations, which means that
the modified values can indirectly affect the configuration of the VNF instance.
These attributes can be initialized with default values from the VNFD (see note 4).
These attributes can be modified with values passed in the request structures of certain LCM operations,
such as the InstantiateVnfRequest structure.
Further, these attributes can be created, modified or deleted with the PATCH method.
NOTE 2: ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on TOSCA specifications.
NOTE 4: Upon creation of the VnfInstance structure, the VNFM shall create and initialize all child attributes
of "vnfConfigurableProperties", "metadata" and "extensions" that were declared in the VNFD with a defined
initial value. The defined initial values can be declared in the VNFD, and/or, in case of "metadata",
obtained from the "CreateVnfRequest" structure. Child attributes of "vnfConfigurableProperties", "metadata"
and "extensions" that have no defined initial value shall not be created, in order to be consistent with the
semantics of the JSON Merge Patch method (see IETF RFC 7396) that interprets null values as deletion request.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
_links:
description: >
......@@ -363,12 +365,9 @@ definitions:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
vnfConfigurableProperties:
description: >
This parameter provides values for the VNF configurable
properties attribute in the "VnfInstance", as defined in
clause 5.5.2.2. If an entry with the same key exists in the
VnfInstance data structure, the VNFM shall replace its
value with the value passed in the InstantiateVnfRequest
data structure.
If present, this attribute provides modifications to the default values, as obtained from the VNFD,
of the "vnfConfigurableProperties" attribute in "VnfInstance", as defined in clause 5.5.2.2.
Provisions for handling configurable properties during the operation are defined in clause 5.4.4.3.1.
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/KeyValuePairs"
ChangeVnfFlavourRequest:
......@@ -609,7 +608,7 @@ definitions:
vnfcInfoModifications:
description: >
Modifications of certain entries in the "vnfcInfo" attribute array in the
"instantiatedVnfInfo" attribute of "VnfInstance"." to be used as "newList" as defined below this table.
"instantiatedVnfInfo" attribute of "VnfInstance" to be used as "newList" as defined below this table.
type: array
items:
$ref: "../../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/VnfcInfoModifications"
......@@ -868,10 +867,10 @@ definitions:
structures that are represented by the "vnfVirtualLinkResource¬Info" or "extManagedVirtualLinkInfo"
attribute in the "VnfInstance" structure. See note.
NOTE: When signalling the addition (LINK_PORT_ADDED) or removal (LINK_PORT_REMOVED) of VNF link
ports, the "networkResource" and "resourceDefinitionId" attributes refer to the affected virtual
link instance, not the link port instance. The resource handles of the affected VNF link ports can
be found by dereferencing the identifiers in the "vnfLinkPortIds" attribute.
NOTE: When signalling the addition (LINK_PORT_ADDED) or removal (LINK_PORT_REMOVED) of VNF link ports,
the "networkResource" attribute refers to the affected virtual link instance, not the link port
instance. The resource handles of the affected VNF link ports can be found by dereferencing the
identifiers in the "vnfLinkPortIds" attribute.
type: array
items:
$ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
......
src/SOL002/VNFLifecycleManagementNotification/VNFLifecycleManagementNotification.yaml
View file @ dfc267e6
......@@ -118,7 +118,7 @@ paths:
get:
description: >
The GET method allows the server to test the notification endpoint
The GET method allows the API producer to test the notification endpoint
that is provided by the API consumer, e.g. during subscription.
parameters:
- name: Authorization
......@@ -256,7 +256,7 @@ paths:
get:
description: >
The GET method allows the server to test the notification endpoint
The GET method allows the API producer to test the notification endpoint
that is provided by the API consumer, e.g. during subscription.
parameters:
- name: Authorization
......@@ -394,7 +394,7 @@ paths:
get:
description: >
The GET method allows the server to test the notification endpoint
The GET method allows the API producer to test the notification endpoint
that is provided by the API consumer, e.g. during subscription.
parameters:
- name: Authorization
......
src/SOL002/VNFPerformanceManagement/VNFPerformanceManagement.yaml
View file @ dfc267e6
......@@ -146,7 +146,7 @@ paths:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
get:
description: >
The client can use this method to retrieve information about PM jobs.
The API consumer can use this method to retrieve information about PM jobs.
parameters:
- name: Accept
description: >
......@@ -166,7 +166,7 @@ paths:
description: >
Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013.
The VNFM shall support receiving this parameter as part of the URI query string.
The EM may supply this parameter. All attribute names that appear in the PmJob
The API consumer may supply this parameter. All attribute names that appear in the PmJob
and in data types referenced from it shall be supported by the VNFM in attribute-based filtering expression.
EXAMPLE
......@@ -337,7 +337,7 @@ paths:
type: string
get:
description: >
The client can use this method for reading an individual PM job.
The API consumer can use this method for reading an individual PM job.
parameters:
- name: Accept
description: >
......@@ -572,7 +572,7 @@ paths:
type: string
get:
description: >
The client can use this method for reading an individual performance
The API consumer can use this method for reading an individual performance
report.
parameters:
- name: Accept
......@@ -657,7 +657,7 @@ paths:
type: string
post:
description: >
The POST method can be used by the client to create a threshold.
The POST method can be used by the API consumer to create a threshold.
As the result of successfully executing this method, a new
"Individual threshold" resource as defined in clause 6.4.6 shall
have been created.
......@@ -744,7 +744,7 @@ paths:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504"
get:
description: >
The client can use this method to query information about thresholds.
The API consumer can use this method to query information about thresholds.
parameters:
- name: Accept
description: >
......@@ -896,7 +896,7 @@ paths:
type: string
get:
description: >
The client can use this method for reading an individual threshold.
The API consumer can use this method for reading an individual threshold.
parameters:
- name: Accept
description: >
......
src/SOL002/VNFPerformanceManagementNotification/VNFPerformanceManagementNotification.yaml
View file @ dfc267e6
......@@ -111,7 +111,7 @@ paths:
get:
description: >
The GET method allows the API producer to test the notification endpoint
that is provided by the client, e.g. during subscription.
that is provided by the API consumer, e.g. during subscription.
parameters:
- name: Authorization
description: >
......@@ -240,8 +240,8 @@ paths:
$ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503"
get:
description: >
The GET method allows the server to test the notification endpoint
that is provided by the client, e.g. during subscription.
The GET method allows the API producer to test the notification endpoint
that is provided by the API consumer, e.g. during subscription.
parameters:
- name: Authorization
description: >
......
src/definitions/SOL002SOL003_def.yaml
View file @ dfc267e6
......@@ -696,6 +696,9 @@ definitions:
LcmOperationType:
description: >
The enumeration LcmOpType defines the permitted values to represent VNF lifecycle operation
types in VNF lifecycle management operation occurrence resources and VNF lifecycle management
operation occurrence notifications. It shall comply with the provisions defined in table 5.5.4.5-1.
Value | Description
------|------------
INSTANTIATE | Represents the "Instantiate VNF" LCM operation.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment