Skip to content
GitLab
Commit 15714d32 authored by Giacomo Bernini's avatar Giacomo Bernini
Browse files

updated summary

parent f8671fbc
Pipeline #6784 passed with stage
in 0 seconds
Show whitespace changes
Inline Side-by-side
src/SOL005/NSDManagement/NSDManagement.yaml
View file @ 15714d32
......@@ -60,7 +60,6 @@ paths:
type: string
post:
summary: Create a new NS descriptor resource.
description: >
The POST method is used to create a new NS descriptor resource.
parameters:
......@@ -139,7 +138,6 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/504"
get:
summary: Query information about multiple NS descriptor resources.
description: >
The GET method queries information about multiple NS descriptor resources.
parameters:
......@@ -293,7 +291,6 @@ paths:
type: string
get:
summary: Read information about an individual NS descriptor resource.
description: >
The GET method reads information about an individual NS descriptor.
parameters:
......@@ -356,7 +353,6 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/504"
patch:
summary: Modify the operational state and/or the user defined data of an individual NS descriptor resource.
description: >
The PATCH method modifies the operational state and/or user defined data of an individual NS descriptor resource.
This method can be used to:
......@@ -450,7 +446,6 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/504"
delete:
summary: Delete an individual NS descriptor resource.
description: >
The DELETE method deletes an individual NS descriptor resource.
An individual NS descriptor resource can only be deleted when there is no NS instance using it (i.e. usageState =
......@@ -551,7 +546,6 @@ paths:
type: string
get:
summary: Fetch the content of a NSD.
description: >
The GET method fetches the content of the NSD archive.
The NSD archive is implemented as a single zip file.
......@@ -685,7 +679,6 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/504"
put:
summary: Upload the content of a NSD.
description: >
The PUT method is used to upload the content of an NSD archive.
The NSD to be uploaded is implemented as a single ZIP file as defined in clause 5.4.4.3.2.
......@@ -954,7 +947,6 @@ paths:
type: string
get:
summary: Fetch the content of the manifest in an NSD archive.
description: >
The GET method reads the content of the manifest file within an NSD archive.
This method shall follow the provisions specified in the Tables 5.4.4b.3.2-1
......@@ -1074,7 +1066,6 @@ paths:
type: string
post:
summary: Create a new PNF descriptor resource.
description: >
The POST method is used to create a new PNF descriptor resource
parameters:
......@@ -1154,7 +1145,6 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/504"
get:
summary: Query information about multiple PNF descriptor resources.
description: >
"The GET method queries information about multiple PNF descriptor
resources."
......@@ -1295,7 +1285,6 @@ paths:
type: string
get:
summary: Read an individual PNFD resource.
description: >
The GET method reads information about an individual PNF descriptor.
parameters:
......@@ -1371,7 +1360,6 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/504"
patch:
summary: Modify the user defined data of an individual PNF descriptor resource.
description: >
The PATCH method modifies the user defined data of an individual PNF descriptor resource.
parameters:
......@@ -1454,7 +1442,6 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/504"
delete:
summary: Delete an individual PNF descriptor resource.
description: >
The DELETE method deletes an individual PNF descriptor resource.
An individual PNF descriptor resource can only be deleted when t
......@@ -1541,7 +1528,6 @@ paths:
type: string
get:
summary: Fetch the content of a PNFD.
description: >
The GET method fetches the content of the PNFD archive.
The content of the PNFD archive is provided as onboarded,
......@@ -1677,7 +1663,6 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/504"
put:
summary: Upload the content of a PNFD.
description: >
The PUT method is used to upload the content of a PNFD archive.
This resource represents the content of the individual PNF descriptor, i.e. PNFD content.
......@@ -2078,7 +2063,6 @@ paths:
type: string
post:
summary: Subscribe to NSD and PNFD change notifications.
description: >
The POST method creates a new subscription.
This method shall support the URI query parameters, request and
......@@ -2184,7 +2168,6 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/504"
get:
summary: Query multiple subscriptions.
description: >
TThe GET method queries the list of active subscriptions of the
functional block that invokes the method. It can be used e.g.
......@@ -2320,7 +2303,6 @@ paths:
type: string
get:
summary: Read an individual subscription resource.
description: >
This resource represents an individual subscription.
It can be used by the client to read and to terminate a subscription to
......@@ -2389,7 +2371,6 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/504"
delete:
summary: Terminate Subscription
description: >
This resource represents an individual subscription.
It can be used by the client to read and to terminate a subscription to
......
src/SOL005/NSDManagementNotification/NSDManagementNotification.yaml
View file @ 15714d32
......@@ -49,7 +49,6 @@ paths:
type: string
post:
summary: Notify about NSD and PNFD changes
description: >
The POST method delivers a notification from the API producer to the API consumer.
This method shall support the URI query parameters, request and
......@@ -116,7 +115,6 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
get:
summary: Test the notification endpoint
description: >
The GET method allows the API producer to test the notification endpoint
that is provided by the API consumer, e.g. during subscription.
......@@ -189,7 +187,6 @@ paths:
type: string
post:
summary: Notify about NSD and PNFD changes
description: >
The POST method delivers a notification from the API producer to the API consumer.
This method shall support the URI query parameters, request and
......@@ -256,7 +253,6 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
get:
summary: Test the notification endpoint
description: >
The GET method allows the API producer to test the notification endpoint
that is provided by the API consumer, e.g. during subscription.
......@@ -329,7 +325,6 @@ paths:
type: string
post:
summary: Notify about NSD and PNFD changes
description: >
The POST method delivers a notification from the API producer to the API consumer.
This method shall support the URI query parameters, request and
......@@ -396,7 +391,6 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
get:
summary: Test the notification endpoint
description: >
The GET method allows the API producer to test the notification endpoint
that is provided by the API consumer, e.g. during subscription.
......@@ -469,7 +463,6 @@ paths:
type: string
post:
summary: Notify about NSD and PNFD changes
description: >
The POST method delivers a notification from the API producer to the API consumer.
This method shall support the URI query parameters, request and
......@@ -536,7 +529,6 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
get:
summary: Test the notification endpoint
description: >
The GET method allows the API producer to test the notification endpoint
that is provided by the API consumer, e.g. during subscription.
......@@ -609,7 +601,6 @@ paths:
type: string
post:
summary: Notify about NSD and PNFD changes
description: >
The POST method delivers a notification from the API producer to the API consumer.
This method shall support the URI query parameters, request and
......@@ -676,7 +667,6 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
get:
summary: Test the notification endpoint
description: >
The GET method allows the API producer to test the notification endpoint
that is provided by the API consumer, e.g. during subscription.
......@@ -749,7 +739,6 @@ paths:
type: string
post:
summary: Notify about NSD and PNFD changes
description: >
The POST method delivers a notification from the API producer to the API consumer.
This method shall support the URI query parameters, request and
......@@ -816,7 +805,6 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
get:
summary: Test the notification endpoint
description: >
The GET method allows the API producer to test the notification endpoint
that is provided by the API consumer, e.g. during subscription.
......@@ -889,7 +877,6 @@ paths:
type: string
post:
summary: Notify about NSD and PNFD changes
description: >
The POST method delivers a notification from the API producer to the API consumer.
This method shall support the URI query parameters, request and
......@@ -956,7 +943,6 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
get:
summary: Test the notification endpoint
description: >
The GET method allows the API producer to test the notification endpoint
that is provided by the API consumer, e.g. during subscription.
......
src/SOL005/NSFaultManagement/NSFaultManagement.yaml
View file @ 15714d32
......@@ -53,7 +53,6 @@ paths:
required: true
type: string
get:
summary: Query alarms related to NS instances.
description: >
Get Alarm List.
......@@ -183,7 +182,6 @@ paths:
required: true
type: string
get:
summary: Read individual alarm.
description: >
The API consumer can use this method to read an individual alarm.
This method shall follow the provisions specified in the Tables 8.4.3.3.2-1 and 8.4.3.3.2-2 for URI query parameters,
......@@ -249,7 +247,6 @@ paths:
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
patch:
summary: Acknowledge individual alarm.
description: >
Acknowledge Alarm
......@@ -366,7 +363,6 @@ paths:
required: true
type: string
post:
summary: Subscribe to alarms related to NSs.
description: >
The POST method creates a new subscription.
This method shall follow the provisions specified in the Tables 8.4.4.3.1-1 and 8.4.4.3.1-2 for URI query
......@@ -451,7 +447,6 @@ paths:
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
get:
summary: Query multiple subscriptions.
description: >
Query Subscription Information
......@@ -590,7 +585,6 @@ paths:
required: true
type: string
get:
summary: Read an individual subscription.
description: >
Query Subscription Information
......@@ -659,7 +653,6 @@ paths:
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
delete:
summary: Terminate a subscription.
description: >
Terminate Subscription
......
src/SOL005/NSFaultManagementNotification/NSFaultManagementNotification.yaml
View file @ 15714d32
......@@ -33,7 +33,6 @@ paths:
##################################################################################
'/URI_is_provided_by_the_client_when_creating_the_subscription-AlarmNotification':
post:
summary: Notify about NS alarms
description: >
The POST method notifies an alarm related to a NS or that the alarm list has been rebuilt.
The API consumer shall have previously created an "individual subscription resource" with a matching filter.
......@@ -105,7 +104,6 @@ paths:
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
get:
summary: Test the notification endpoint.
description: >
The GET method allows the server to test the notification endpoint that is provided by
the API consumer, e.g. during subscription.
......@@ -172,7 +170,6 @@ paths:
'/URI_is_provided_by_the_client_when_creating_the_subscription-AlarmClearedNotification':
#ETSI GS NFV-SOL 005 V2.8.1 location: 8.4.6
post:
summary: Notify about NS alarms
description: >
The POST method notifies an alarm related to a NS or that the alarm list has been rebuilt.
parameters:
......@@ -243,7 +240,6 @@ paths:
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
get:
summary: Test the notification endpoint.
description: >
The GET method allows the server to test the notification endpoint that is provided by
the client, e.g. during subscription.
......@@ -309,7 +305,6 @@ paths:
'/URI_is_provided_by_the_client_when_creating_the_subscription-AlarmListRebuiltNotification':
post:
summary: Notify about NS alarms
description: >
The POST method notifies an alarm related to a NS or that the alarm list has been rebuilt.
parameters:
......@@ -380,7 +375,6 @@ paths:
503:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
get:
summary: Test the notification endpoint.
description: >
The GET method allows the server to test the notification endpoint that is provided by
the API consumer, e.g. during subscription.
......
src/SOL005/NSLifecycleManagement/NSLifecycleManagement.yaml
View file @ 15714d32
......@@ -52,7 +52,6 @@ paths:
required: true
type: string
post:
summary: Create a NS instance resource.
description: >
The POST method creates a new NS instance resource.
As the result of successfully executing this method, a new "Individual NS instance" resource as defined in clause 6.4.3
......@@ -141,7 +140,6 @@ paths:
504:
$ref: "../responses/SOL005_resp.yaml#/responses/504"
get:
summary: Query multiple NS instances.
description: >
Query NS Instances.
......@@ -316,7 +314,6 @@ paths:
required: true
type: string
get:
summary: Read an individual NS instance resource.
description: >
The GET method retrieves information about a NS instance by
reading an individual NS instance resource.
......@@ -390,7 +387,6 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/504"
delete:
summary: Delete NS instance resource.
description: >
Delete NS Identifier
......@@ -469,7 +465,6 @@ paths:
type: string
required: true
post:
summary: Instantiate a NS.
description: >
The POST method requests to instantiate a NS instance resource.
The steps and conditions that apply as the result of successfully executing this method are specified in clause 6.4.1.2.
......@@ -573,7 +568,6 @@ paths:
type: string
required: true
post:
summary: Scale a NS instance.
description: >
The POST method requests to scale a NS instance resource.
The steps and conditions that apply as the result of successfully executing this method are specified in clause 6.4.1.2.
......@@ -676,7 +670,6 @@ paths:
type: string
required: true
post:
summary: Updates a NS instance.
description: >
The POST method updates an NS instance.
parameters:
......@@ -774,7 +767,6 @@ paths:
type: string
required: true
post:
summary: Heal a NS instance.
description: >
The POST method requests to heal an NS instance.
This method shall follow the provisions specified in the Tables 6.4.7.3.1-1 and 6.4.7.3.1-2 for URI query parameters,
......@@ -875,7 +867,6 @@ paths:
type: string
required: true
post:
summary: Terminate a NS instance.
description: >
Terminate NS task.
The POST method terminates an NS instance.
......@@ -973,7 +964,6 @@ paths:
'/ns_lcm_op_occs':
#ETSI GS NFV-SOL 005 V2.8.1 location: 6.4.9
get:
summary: Query multiple NS LCM operation occurrences.
description: >
Get Operation Status.
Shall be returned upon the following error: The
......@@ -1138,7 +1128,6 @@ paths:
type: string
required: true
get:
summary: Read an individual NS LCM operation occurrence resource.
description: >
The API consumer can use this method to retrieve status information about
a NS lifecycle management operation occurrence by
......@@ -1247,7 +1236,6 @@ paths:
type: string
required: true
post:
summary: Retry a NS lifecycle management operation occurrence.
description: >
The POST method initiates retrying a NS lifecycle management operation
if that operation has experienced a temporary
......@@ -1350,7 +1338,6 @@ paths:
required: true
type: string
post:
summary: Rollback a NS lifecycle management operation occurrence.
description: >
The POST method initiates rolling back a NS lifecycle operation
if that operation has experienced a temporary failure,
......@@ -1453,7 +1440,6 @@ paths:
required: true
type: string
post:
summary: Continue a NS lifecycle management operation occurrence.
description: >
The POST method initiates continuing an NS lifecycle operation if that operation has experienced a temporary failure,
i.e. the related "NS LCM operation occurrence" is in "FAILED_TEMP" state.
......@@ -1558,7 +1544,6 @@ paths:
required: true
type: string
post:
summary: Mark a NS lifecycle management operation occurrence as failed.
description: >
The POST method marks a NS lifecycle management operation
occurrence as "finally failed" if that operation
......@@ -1690,7 +1675,6 @@ paths:
required: true
type: string
post:
summary: Cancel a NS lifecycle management operation occurrence.
description: >
The POST method initiates cancelling an ongoing NS lifecycle management operation while it is being executed or
rolled back, i.e. the related "NS LCM operation occurrence" is either in "PROCESSING" or "ROLLING_BACK" state.
......@@ -1828,7 +1812,6 @@ paths:
required: true
type: string
post:
summary: Subscribe to NS lifecycle change notifications.
description: >
The POST method creates a new subscription.
This method shall support the URI query parameters, request and response data structures, and response codes, as
......@@ -1931,7 +1914,6 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/504"
get:
summary: Query multiple subscriptions.
description: >
Query Subscription Information.
......@@ -2061,7 +2043,6 @@ paths:
required: true
type: string
get:
summary: Read an individual subscription resource.
description: >
The GET method retrieves information about a subscription by reading an individual subscription resource.
This method shall support the URI query parameters, request and response data structures, and response codes, as
......@@ -2125,7 +2106,6 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/504"
delete:
summary: Terminate a subscription.
description: >
The DELETE method terminates an individual subscription.
This method shall support the URI query parameters, request and response data structures, and response codes, as
......
src/SOL005/NSLifecycleManagementNotification/NSLifecycleManagementNotification.yaml
View file @ 15714d32
......@@ -33,7 +33,6 @@ paths:
##################################################################################
'/URI_is_provided_by_the_client_when_creating_the_subscription-NsLcmOperationOccurrenceNotification':
post:
summary: Notify about NS lifecycle change
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.
......@@ -114,7 +113,6 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
get:
summary: Test the notification endpoint.
description: >
Query NS Instances.
......@@ -184,7 +182,7 @@ paths:
'/URI_is_provided_by_the_client_when_creating_the_subscription-NsIdentifierCreationNotification':
post:
summary: Notify about NS lifecycle change
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.
This method shall follow the provisions specified in the Tables 6.4.18.3.1-1 and 6.4.18.3.1-2 for URI query parameters,
......@@ -264,7 +262,6 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
get:
summary: Test the notification endpoint.
description: >
Query NS Instances.
......@@ -334,7 +331,6 @@ paths:
'/URI_is_provided_by_the_client_when_creating_the_subscription-NsIdentifierDeletionNotification':
post:
summary: Notify about NS lifecycle change
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.
......@@ -416,7 +412,6 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
get:
summary: Test the notification endpoint.
description: >
Query NS Instances.
......
src/SOL005/NSPerformanceManagement/NSPerformanceManagement.yaml
View file @ 15714d32
......@@ -60,7 +60,6 @@ paths:
type: string
post:
summary: Create a PM job.
description: >
The POST method creates a PM job.
This method shall follow the provisions specified in the
......@@ -144,7 +143,6 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
get:
summary: Query PM jobs.
description: >
The API consumer can use this method to retrieve information about PM jobs.
parameters:
......@@ -308,7 +306,6 @@ paths:
type: string
get:
summary: Read a single PM job.
description: >
The API consumer can use this method for reading an individual PM job.
parameters:
......@@ -368,7 +365,6 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
patch:
summary: Modify a PM job.
description: >
This method allows to modify an "individual PM job" resource.
This method shall follow the provisions specified in the
......@@ -435,7 +431,6 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
delete:
summary: Delete a PM job.
description: >
This method terminates an individual PM job.
This method shall follow the provisions specified in the Tables 7.4.3.3.5-1
......@@ -515,7 +510,6 @@ paths:
type: string
get:
summary: Read an individual performance report.
description: >
The API consumer can use this method for reading an individual performance
report.
......@@ -596,7 +590,6 @@ paths:
type: string
post:
summary: Create a threshold.
description: >
The POST method can be used by the API consumer to create
a threshold.
......@@ -684,7 +677,6 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
get:
summary: Query thresholds.
description: >
The API consumer can use this method to query information about thresholds.
parameters:
......@@ -807,7 +799,6 @@ paths:
type: string
get:
summary: Query a single threshold.
description: >
The API consumer can use this method for reading an individual
threshold.
......@@ -871,7 +862,6 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
patch:
summary: Modify a Threshold
description: >
This method allows to modify an "Individual threshold" resource.
This method shall follow the provisions specified in the Tables
......@@ -935,7 +925,6 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/503"
delete:
summary: Delete a Threshold.
description: >
This method allows to delete a threshold.