Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in
Toggle navigation
Menu
Open sidebar
NFV - Network Functions Virtualisation
SOL002-SOL003
Commits
7b7dee37
Commit
7b7dee37
authored
Jan 14, 2022
by
Muhammad Hamza
Browse files
fix issue
#3
- redefine global query parameters in SOL003 locally
parent
a5755264
Pipeline
#10319
passed with stage
in 0 seconds
Changes
14
Pipelines
1
Expand all
Show whitespace changes
Inline
Side-by-side
src/SOL003/VNFFaultManagement/VNFFaultManagement.yaml
View file @
7b7dee37
...
...
@@ -42,10 +42,10 @@ paths:
description
:
|
The API consumer can use this method to retrieve information about the alarm list. See clause 7.4.2.3.2.
parameters
:
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Accept
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/ContentType
-
$ref
:
../../components/SOL002SOL003_params.yaml
#/components/parameters/filter
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Accept
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/ContentType
-
$ref
:
'
#/components/parameters/filter
_alarm_list'
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
_vnfm
responses
:
200
:
$ref
:
'
#/components/responses/Alarms.Get.200'
...
...
@@ -77,10 +77,10 @@ paths:
#SOL003 location: 7.4.3
parameters
:
-
$ref
:
'
#/components/parameters/AlarmId'
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Accept
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/ContentType
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Authorization
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Version
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Accept
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/ContentType
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Authorization
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Version
get
:
description
:
|
The API consumer can use this method to read an individual alarm. See clause 7.4.3.3.2.
...
...
@@ -147,10 +147,10 @@ paths:
/subscriptions
:
#SOL003 location: 7.4.4
parameters
:
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Accept
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/ContentType
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Authorization
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Version
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Accept
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/ContentType
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Authorization
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Version
post
:
description
:
|
The POST method creates a new subscription. See clause 7.4.4.3.1.
...
...
@@ -187,8 +187,8 @@ paths:
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. See clause 7.4.4.3.2.
parameters
:
-
$ref
:
../../components/SOL002SOL003_params.yaml
#/components/parameters/filter
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
-
$ref
:
'
#/components/parameters/filter
_subscriptions'
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
_vnfm
responses
:
200
:
$ref
:
'
#/components/responses/Subscriptions.Get.200'
...
...
@@ -220,15 +220,15 @@ paths:
#SOL003 location: 7.4.5
parameters
:
-
$ref
:
'
#/components/parameters/SubscriptionId'
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Version
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Authorization
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Version
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Authorization
get
:
description
:
|
The API consumer can use this method for reading an individual subscription for VNF
alarms subscribed by the API consumer. See clause 7.4.5.3.2.
parameters
:
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Accept
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/ContentType
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Accept
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/ContentType
responses
:
200
:
$ref
:
'
#/components/responses/IndividualSubscription.Get.200'
...
...
@@ -283,6 +283,37 @@ paths:
components
:
parameters
:
filter_alarm_list
:
name
:
filter
description
:
>
Attribute-based filtering expression according to clause 5.2 of ETSI
GS NFV-SOL 013 [8].
The VNFM shall support receiving this parameter as part of the URI query string.
The NFVO may supply this parameter.
The following attribute names shall be supported by the VNFM in the attribute based filtering
expression: id, managedObjectId,
rootCauseFaultyResource/faultyResourceType, eventType, perceivedSeverity,
probableCause.
in
:
query
required
:
false
schema
:
type
:
string
filter_subscriptions
:
name
:
filter
description
:
>
Attribute-based filtering expression according to clause 5.2 of ETSI
GS NFV-SOL 013 [8].
The VNFM shall support receiving this parameter as part of the URI
query string. The NFVO may supply this parameter.
All attribute names that appear in the FmSubscription and in data types
referenced from it shall be supported by the VNFM in the filter
expression.
in
:
query
required
:
false
schema
:
type
:
string
AlarmId
:
name
:
alarmId
in
:
path
...
...
src/SOL003/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml
View file @
7b7dee37
...
...
@@ -33,14 +33,14 @@ paths:
/URI_is_provided_by_the_client_when_creating_the_subscription-AlarmNotification
:
#SOL003 location: 7.4.6
parameters
:
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Authorization
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Version
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Authorization
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Version
post
:
description
:
|
The POST method notifies a VNF alarm or that the alarm list has been rebuilt. The API consumer shall have
previously created an "Individual subscription" resource with a matching filter. See clause 7.4.6.3.1.
parameters
:
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/ContentType
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/ContentType
requestBody
:
$ref
:
'
#/components/requestBodies/AlarmNotification'
responses
:
...
...
@@ -89,14 +89,14 @@ paths:
/URI_is_provided_by_the_client_when_creating_the_subscription-AlarmClearedNotification
:
#SOL003 location: 7.4.6
parameters
:
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Authorization
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Version
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Authorization
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Version
post
:
description
:
|
The POST method notifies a VNF alarm or that the alarm list has been rebuilt. The API consumer shall have
previously created an "Individual subscription" resource with a matching filter. See clause 7.4.6.3.1.
parameters
:
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/ContentType
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/ContentType
requestBody
:
$ref
:
'
#/components/requestBodies/AlarmClearedNotification'
responses
:
...
...
@@ -145,14 +145,14 @@ paths:
/URI_is_provided_by_the_client_when_creating_the_subscription-AlarmListRebuiltNotification
:
#SOL003 location: 7.4.6
parameters
:
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Authorization
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Version
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Authorization
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Version
post
:
description
:
|
The POST method notifies a VNF alarm or that the alarm list has been rebuilt. The API consumer shall have
previously created an "Individual subscription" resource with a matching filter. See clause 7.4.6.3.1.
parameters
:
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/ContentType
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/ContentType
requestBody
:
$ref
:
'
#/components/requestBodies/AlarmListRebuiltNotification'
responses
:
...
...
src/SOL003/VNFIndicator/VNFIndicator.yaml
View file @
7b7dee37
...
...
@@ -43,11 +43,11 @@ paths:
description
:
|
The GET method queries multiple VNF indicators. See clause 8.4.2.3.2.
parameters
:
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Accept
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Authorization
-
$ref
:
../../components/SOL002SOL003_params.yaml
#/components/parameters/filter
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Version
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Accept
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Authorization
-
$ref
:
'
#/components/parameters/filter
_vnf_indicators'
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
_vnfm
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Version
responses
:
200
:
$ref
:
'
#/components/responses/Indicators.Get.200'
...
...
@@ -83,12 +83,12 @@ paths:
description
:
|
The GET method queries multiple VNF indicators related to a VNF instance. See clause 8.4.3.3.2.
parameters
:
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Accept
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/ContentType
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Authorization
-
$ref
:
../..
/components/
SOL002SOL003_params.yaml#/components/parameters/filter
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Version
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Accept
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/ContentType
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Authorization
-
$ref
:
'
#
/components/
parameters/filter_vnf_indicators_related_to_vnf_instance'
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
_vnfm
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Version
responses
:
200
:
$ref
:
'
#/components/responses/VnfInstanceIndicators.Get.200'
...
...
@@ -125,10 +125,10 @@ paths:
description
:
|
The GET method reads a VNF indicator. See clause 8.4.4.3.2.
parameters
:
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Accept
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/ContentType
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Authorization
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Version
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Accept
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/ContentType
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Authorization
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Version
responses
:
200
:
$ref
:
'
#/components/responses/VnfInstanceIndividualIndicator.Get.200'
...
...
@@ -158,10 +158,10 @@ paths:
###############################################################################
/subscriptions
:
parameters
:
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Accept
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/ContentType
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Authorization
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Version
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Accept
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/ContentType
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Authorization
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Version
post
:
description
:
|
The POST method creates a new subscription. See clause 8.4.5.3.1.
...
...
@@ -198,8 +198,8 @@ paths:
The GET method queries the list of active subscriptions of the functional block that invokes the method.
It can be used e.g. for resynchronization after error situations. See clause 8.4.5.3.2.
parameters
:
-
$ref
:
../../components/SOL002SOL003_params.yaml
#/components/parameters/filter
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
-
$ref
:
'
#/components/parameters/filter
_subscriptions'
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
_vnfm
responses
:
200
:
$ref
:
'
#/components/responses/Subscriptions.Get.200'
...
...
@@ -231,14 +231,14 @@ paths:
#SOL003 location: 8.4.6
parameters
:
-
$ref
:
'
#/components/parameters/SubscriptionId'
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/ContentType
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Authorization
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Version
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/ContentType
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Authorization
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Version
get
:
description
:
|
The GET method reads an individual subscription. See clause 8.4.6.3.2.
parameters
:
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Accept
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Accept
responses
:
200
:
$ref
:
'
#/components/responses/IndividualSubscription.Get.200'
...
...
@@ -292,6 +292,49 @@ paths:
components
:
parameters
:
filter_vnf_indicators
:
name
:
filter
description
:
>
Attribute-based filtering expression according to clause 5.2 of ETSI
GS NFV-SOL 013 [8].
The VNFM shall support receiving this parameter as part of the URI query string.
The NFVO may supply this parameter.
All attribute names that appear in the VnfIndicator data type and in data types
referenced from it shall be supported by the VNFM in the filter expression.
in
:
query
required
:
false
schema
:
type
:
string
filter_vnf_indicators_related_to_vnf_instance
:
name
:
filter
description
:
>
Attribute-based filtering expression according to clause 5.2 of ETSI
GS NFV-SOL 013 [8].
The VNFM shall support receiving this parameter as part of the URI query string.
The NFVO may supply this parameter.
All attribute names that appear in the VnfIndicator data type and in data types
referenced from it shall be supported by the VNFM in the filter expression.
in
:
query
required
:
false
schema
:
type
:
string
filter_subscriptions
:
name
:
filter
description
:
>
Attribute-based filtering expression according to clause 5.2 of ETSI
GS NFV-SOL 013 [8].
The VNFM shall support receiving this parameter as part of the URI query string.
The NFVO may supply this parameter.
All attribute names that appear in the VnfIndicatorSubscription data type and in
data types referenced from it shall be supported by the VNFM in the filter
expression.
in
:
query
required
:
false
schema
:
type
:
string
VnfInstanceId
:
name
:
vnfInstanceId
in
:
path
...
...
src/SOL003/VNFIndicatorNotification/VNFIndicatorNotification.yaml
View file @
7b7dee37
...
...
@@ -37,8 +37,8 @@ paths:
The POST method delivers a notification from the API producer to an API consumer. The API consumer shall
have previously created an "Individual subscription" resource with a matching filter. See clause 8.4.7.3.1.
parameters
:
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Authorization
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Version
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Authorization
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Version
requestBody
:
$ref
:
'
#/components/requestBodies/AlarmListRebuiltNotification'
responses
:
...
...
@@ -64,8 +64,8 @@ paths:
The GET method allows the API producer to test the notification endpoint that is provided by the API consumer,
e.g. during subscription. See clause 8.4.7.3.2.
parameters
:
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Authorization
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Version
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Authorization
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Version
responses
:
204
:
$ref
:
'
#/components/responses/VNFINDNotification.Get.204'
...
...
src/SOL003/VNFLifecycleManagement/VNFLifecycleManagement.yaml
View file @
7b7dee37
This diff is collapsed.
Click to expand it.
src/SOL003/VNFLifecycleManagementNotification/VNFLifecycleManagementNotification.yaml
View file @
7b7dee37
...
...
@@ -32,8 +32,8 @@ paths:
###############################################################################
/URI_is_provided_by_the_client_when_creating_the_subscription-VnfLcmOperationOccurrenceNotification
:
parameters
:
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Authorization
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Version
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Authorization
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Version
post
:
description
:
|
The POST method delivers a notification from the API producer to an API consumer. The API consumer shall
...
...
@@ -85,8 +85,8 @@ paths:
###############################################################################
/URI_is_provided_by_the_client_when_creating_the_subscription-VnfIdentifierCreationNotification
:
parameters
:
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Authorization
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Version
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Authorization
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Version
post
:
description
:
|
The POST method delivers a notification from the API producer to an API consumer. The API consumer shall
...
...
@@ -138,8 +138,8 @@ paths:
###############################################################################
/URI_is_provided_by_the_client_when_creating_the_subscription-VnfIdentifierDeletionNotification
:
parameters
:
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Authorization
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Version
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Authorization
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Version
post
:
description
:
|
The POST method delivers a notification from the API producer to an API consumer. The API consumer shall
...
...
src/SOL003/VNFLifecycleOperationGranting/VNFLifecycleOperationGranting.yaml
View file @
7b7dee37
...
...
@@ -42,9 +42,9 @@ paths:
description
:
|
The POST method requests a grant for a particular VNF lifecycle operation. See clause 9.4.2.3.1.
parameters
:
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Accept
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Authorization
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Version
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Accept
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Authorization
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Version
requestBody
:
$ref
:
'
#/components/requestBodies/GrantRequest'
responses
:
...
...
@@ -84,9 +84,9 @@ paths:
description
:
|
The GET method reads a grant. See clause 9.4.3.3.2.
parameters
:
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Accept
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Authorization
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Version
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Accept
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Authorization
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Version
responses
:
200
:
$ref
:
'
#/components/responses/IndividualGrant.Get.200'
...
...
src/SOL003/VNFPackageManagement/VNFPackageManagement.yaml
View file @
7b7dee37
This diff is collapsed.
Click to expand it.
src/SOL003/VNFPackageManagementNotification/VNFPackageManagementNotification.yaml
View file @
7b7dee37
...
...
@@ -33,15 +33,15 @@ paths:
/URI_is_provided_by_the_client_when_creating_the_subscription-VnfPackageOnboardingNotification
:
#SOL003 location: 10.4.9
parameters
:
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Authorization
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Version
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Authorization
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Version
post
:
description
:
|
The POST method delivers a notification from the API producer to an API consumer.
The API consumer shall have previously created an "Individual subscription" resource with a matching filter.
See clause 10.4.9.3.1.
parameters
:
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/ContentType
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/ContentType
requestBody
:
$ref
:
'
#/components/requestBodies/VnfPackageOnboardingNotification'
responses
:
...
...
@@ -90,15 +90,15 @@ paths:
/URI_is_provided_by_the_client_when_creating_the_subscription-VnfPackageChangeNotification
:
#SOL003 location: 10.4.9
parameters
:
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Authorization
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Version
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Authorization
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Version
post
:
description
:
|
The POST method delivers a notification from the API producer to an API consumer.
The API consumer shall have previously created an "Individual subscription" resource with a matching filter.
See clause 10.4.9.3.1.
parameters
:
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/ContentType
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/ContentType
requestBody
:
$ref
:
'
#/components/requestBodies/VnfPackageChangeNotification'
responses
:
...
...
src/SOL003/VNFPerformanceManagement/VNFPerformanceManagement.yaml
View file @
7b7dee37
...
...
@@ -40,14 +40,14 @@ paths:
/pm_jobs
:
#SOL003 location: 6.4.2
parameters
:
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Accept
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Authorization
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Version
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Accept
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Authorization
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Version
post
:
description
:
|
The POST method creates a PM job. See clause 6.4.2.3.1.
parameters
:
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/ContentType
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/ContentType
requestBody
:
$ref
:
'
#/components/requestBodies/CreatePmJobRequest'
responses
:
...
...
@@ -78,12 +78,12 @@ paths:
description
:
|
The API consumer can use this method to retrieve information about PM jobs. See clause 6.4.2.3.2.
parameters
:
-
$ref
:
../../components/SOL002SOL003_params.yaml
#/components/parameters/filter
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/all_fields
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/fields
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/exclude_fields
-
$ref
:
../../components/SOL002SOL003_params.yaml
#/components/parameters/exclude_default
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
-
$ref
:
'
#/components/parameters/filter
_pm_jobs'
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/all_fields
_vnfm
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/fields
_vnfm
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/exclude_fields
_vnfm
-
$ref
:
'
#/components/parameters/exclude_default
_pm_jobs'
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
_vnfm
responses
:
200
:
$ref
:
'
#/components/responses/PmJobs.Get.200'
...
...
@@ -115,13 +115,13 @@ paths:
#SOL003 location: 6.4.3
parameters
:
-
$ref
:
'
#/components/parameters/PmJobId'
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Authorization
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Version
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Authorization
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Version
get
:
description
:
|
The API consumer can use this method for reading an individual PM job. See clause 6.4.3.3.2.
parameters
:
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Accept
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Accept
responses
:
200
:
$ref
:
'
#/components/responses/IndividualPmJob.Get.200'
...
...
@@ -214,9 +214,9 @@ paths:
description
:
|
The API consumer can use this method for reading an individual performance report. See clause 6.4.4.3.2.
parameters
:
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Accept
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Authorization
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Version
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Accept
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Authorization
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Version
responses
:
200
:
$ref
:
'
#/components/responses/IndividualPerformanceReport.Get.200'
...
...
@@ -247,14 +247,14 @@ paths:
/thresholds
:
#SOL003 location: 6.4.5
parameters
:
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Accept
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Authorization
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Version
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Accept
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Authorization
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Version
post
:
description
:
|
The POST method can be used by the API consumer to create a threshold. See clause 6.4.5.3.1.
parameters
:
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/ContentType
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/ContentType
requestBody
:
$ref
:
'
#/components/requestBodies/CreateThresholdRequest'
responses
:
...
...
@@ -285,8 +285,8 @@ paths:
description
:
|
The API consumer can use this method to query information about thresholds. See clause 6.4.5.3.2.
parameters
:
-
$ref
:
../../components/SOL002SOL003_params.yaml
#/components/parameters/filter
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
-
$ref
:
'
#/components/parameters/filter
_thresholds'
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/nextpage_opaque_marker
_vnfm
responses
:
200
:
$ref
:
'
#/components/responses/Thresholds.Get.200'
...
...
@@ -318,13 +318,13 @@ paths:
#SOL003 location: 6.4.6
parameters
:
-
$ref
:
'
#/components/parameters/ThresholdId'
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Authorization
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Version
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Authorization
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Version
get
:
description
:
|
The API consumer can use this method for reading an individual threshold. See clause 6.4.6.3.2.
parameters
:
-
$ref
:
../../components/
SOL002
SOL003_params.yaml#/components/parameters/Accept
-
$ref
:
../../components/SOL003_params.yaml#/components/parameters/Accept
responses
:
200
:
$ref
:
'
#/components/responses/IndividualThreshold.Get.200'
...
...
@@ -407,6 +407,48 @@ paths:
components
:
parameters
:
filter_pm_jobs
:
name
:
filter
description
:
>
Attribute-based filtering expression according to clause 5.2 of ETSI
GS NFV-SOL 013 [8].
The VNFM shall support receiving this parameter as part of the URI query string. The
NFVO 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 the filter expression.
in
:
query
required
:
false
schema
:
type
:
string
exclude_default_pm_jobs
:
name
:
exclude_default
in
:
query
description
:
>-
Indicates to exclude the following complex attributes from the response. See clause 5.3
of ETSI GS NFV-SOL 013 [8] for details. The VNFM shall support this parameter.
The following attributes shall be excluded from the PmJob structure in the response
body if this parameter is provided, or none of the parameters "all_fields," "fields",
"exclude_fields", "exclude_default" are provided:
- reports
required
:
false
schema
:
type
:
string
filter_thresholds
:
name
:
filter
description
:
>
Attribute-based filtering expression according to clause 5.2 of ETSI
GS NFV-SOL 013 [8].
The VNFM shall support receiving this parameter as part of the URI query string. The
NFVO may supply this parameter.
All attribute names that appear in the Thresholds data type and in data types referenced
from it shall be supported by the VNFM in the filter expression
in
:
query
required
:
false
schema
:
type
:
string
PmJobId
:
name
:
pmJobId