Commit 15714d32 authored by Giacomo Bernini's avatar Giacomo Bernini
Browse files

updated summary

parent f8671fbc
Pipeline #6784 passed with stage
in 0 seconds
...@@ -60,7 +60,6 @@ paths: ...@@ -60,7 +60,6 @@ paths:
type: string type: string
post: post:
summary: Create a new NS descriptor resource.
description: > description: >
The POST method is used to create a new NS descriptor resource. The POST method is used to create a new NS descriptor resource.
parameters: parameters:
...@@ -139,7 +138,6 @@ paths: ...@@ -139,7 +138,6 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/504" $ref: "../responses/SOL005_resp.yaml#/responses/504"
get: get:
summary: Query information about multiple NS descriptor resources.
description: > description: >
The GET method queries information about multiple NS descriptor resources. The GET method queries information about multiple NS descriptor resources.
parameters: parameters:
...@@ -293,7 +291,6 @@ paths: ...@@ -293,7 +291,6 @@ paths:
type: string type: string
get: get:
summary: Read information about an individual NS descriptor resource.
description: > description: >
The GET method reads information about an individual NS descriptor. The GET method reads information about an individual NS descriptor.
parameters: parameters:
...@@ -356,7 +353,6 @@ paths: ...@@ -356,7 +353,6 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/504" $ref: "../responses/SOL005_resp.yaml#/responses/504"
patch: patch:
summary: Modify the operational state and/or the user defined data of an individual NS descriptor resource.
description: > description: >
The PATCH method modifies the operational state and/or user defined data of an individual NS descriptor resource. The PATCH method modifies the operational state and/or user defined data of an individual NS descriptor resource.
This method can be used to: This method can be used to:
...@@ -450,7 +446,6 @@ paths: ...@@ -450,7 +446,6 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/504" $ref: "../responses/SOL005_resp.yaml#/responses/504"
delete: delete:
summary: Delete an individual NS descriptor resource.
description: > description: >
The DELETE method deletes an individual NS descriptor resource. 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 = 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: ...@@ -551,7 +546,6 @@ paths:
type: string type: string
get: get:
summary: Fetch the content of a NSD.
description: > description: >
The GET method fetches the content of the NSD archive. The GET method fetches the content of the NSD archive.
The NSD archive is implemented as a single zip file. The NSD archive is implemented as a single zip file.
...@@ -685,7 +679,6 @@ paths: ...@@ -685,7 +679,6 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/504" $ref: "../responses/SOL005_resp.yaml#/responses/504"
put: put:
summary: Upload the content of a NSD.
description: > description: >
The PUT method is used to upload the content of an NSD archive. 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. 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: ...@@ -954,7 +947,6 @@ paths:
type: string type: string
get: get:
summary: Fetch the content of the manifest in an NSD archive.
description: > description: >
The GET method reads the content of the manifest file within an NSD archive. 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 This method shall follow the provisions specified in the Tables 5.4.4b.3.2-1
...@@ -1074,7 +1066,6 @@ paths: ...@@ -1074,7 +1066,6 @@ paths:
type: string type: string
post: post:
summary: Create a new PNF descriptor resource.
description: > description: >
The POST method is used to create a new PNF descriptor resource The POST method is used to create a new PNF descriptor resource
parameters: parameters:
...@@ -1154,7 +1145,6 @@ paths: ...@@ -1154,7 +1145,6 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/504" $ref: "../responses/SOL005_resp.yaml#/responses/504"
get: get:
summary: Query information about multiple PNF descriptor resources.
description: > description: >
"The GET method queries information about multiple PNF descriptor "The GET method queries information about multiple PNF descriptor
resources." resources."
...@@ -1295,7 +1285,6 @@ paths: ...@@ -1295,7 +1285,6 @@ paths:
type: string type: string
get: get:
summary: Read an individual PNFD resource.
description: > description: >
The GET method reads information about an individual PNF descriptor. The GET method reads information about an individual PNF descriptor.
parameters: parameters:
...@@ -1371,7 +1360,6 @@ paths: ...@@ -1371,7 +1360,6 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/504" $ref: "../responses/SOL005_resp.yaml#/responses/504"
patch: patch:
summary: Modify the user defined data of an individual PNF descriptor resource.
description: > description: >
The PATCH method modifies the user defined data of an individual PNF descriptor resource. The PATCH method modifies the user defined data of an individual PNF descriptor resource.
parameters: parameters:
...@@ -1454,7 +1442,6 @@ paths: ...@@ -1454,7 +1442,6 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/504" $ref: "../responses/SOL005_resp.yaml#/responses/504"
delete: delete:
summary: Delete an individual PNF descriptor resource.
description: > description: >
The DELETE method deletes an individual PNF descriptor resource. The DELETE method deletes an individual PNF descriptor resource.
An individual PNF descriptor resource can only be deleted when t An individual PNF descriptor resource can only be deleted when t
...@@ -1541,7 +1528,6 @@ paths: ...@@ -1541,7 +1528,6 @@ paths:
type: string type: string
get: get:
summary: Fetch the content of a PNFD.
description: > description: >
The GET method fetches the content of the PNFD archive. The GET method fetches the content of the PNFD archive.
The content of the PNFD archive is provided as onboarded, The content of the PNFD archive is provided as onboarded,
...@@ -1677,7 +1663,6 @@ paths: ...@@ -1677,7 +1663,6 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/504" $ref: "../responses/SOL005_resp.yaml#/responses/504"
put: put:
summary: Upload the content of a PNFD.
description: > description: >
The PUT method is used to upload the content of a PNFD archive. 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. This resource represents the content of the individual PNF descriptor, i.e. PNFD content.
...@@ -2078,7 +2063,6 @@ paths: ...@@ -2078,7 +2063,6 @@ paths:
type: string type: string
post: post:
summary: Subscribe to NSD and PNFD change notifications.
description: > description: >
The POST method creates a new subscription. The POST method creates a new subscription.
This method shall support the URI query parameters, request and This method shall support the URI query parameters, request and
...@@ -2184,7 +2168,6 @@ paths: ...@@ -2184,7 +2168,6 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/504" $ref: "../responses/SOL005_resp.yaml#/responses/504"
get: get:
summary: Query multiple subscriptions.
description: > description: >
TThe GET method queries the list of active subscriptions of the TThe GET method queries the list of active subscriptions of the
functional block that invokes the method. It can be used e.g. functional block that invokes the method. It can be used e.g.
...@@ -2320,7 +2303,6 @@ paths: ...@@ -2320,7 +2303,6 @@ paths:
type: string type: string
get: get:
summary: Read an individual subscription resource.
description: > description: >
This resource represents an individual subscription. This resource represents an individual subscription.
It can be used by the client to read and to terminate a subscription to It can be used by the client to read and to terminate a subscription to
...@@ -2389,7 +2371,6 @@ paths: ...@@ -2389,7 +2371,6 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/504" $ref: "../responses/SOL005_resp.yaml#/responses/504"
delete: delete:
summary: Terminate Subscription
description: > description: >
This resource represents an individual subscription. This resource represents an individual subscription.
It can be used by the client to read and to terminate a subscription to It can be used by the client to read and to terminate a subscription to
......
...@@ -49,7 +49,6 @@ paths: ...@@ -49,7 +49,6 @@ paths:
type: string type: string
post: post:
summary: Notify about NSD and PNFD changes
description: > description: >
The POST method delivers a notification from the API producer to the API consumer. The POST method delivers a notification from the API producer to the API consumer.
This method shall support the URI query parameters, request and This method shall support the URI query parameters, request and
...@@ -116,7 +115,6 @@ paths: ...@@ -116,7 +115,6 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/503" $ref: "../responses/SOL005_resp.yaml#/responses/503"
get: get:
summary: Test the notification endpoint
description: > description: >
The GET method allows the API producer 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. that is provided by the API consumer, e.g. during subscription.
...@@ -189,7 +187,6 @@ paths: ...@@ -189,7 +187,6 @@ paths:
type: string type: string
post: post:
summary: Notify about NSD and PNFD changes
description: > description: >
The POST method delivers a notification from the API producer to the API consumer. The POST method delivers a notification from the API producer to the API consumer.
This method shall support the URI query parameters, request and This method shall support the URI query parameters, request and
...@@ -256,7 +253,6 @@ paths: ...@@ -256,7 +253,6 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/503" $ref: "../responses/SOL005_resp.yaml#/responses/503"
get: get:
summary: Test the notification endpoint
description: > description: >
The GET method allows the API producer 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. that is provided by the API consumer, e.g. during subscription.
...@@ -329,7 +325,6 @@ paths: ...@@ -329,7 +325,6 @@ paths:
type: string type: string
post: post:
summary: Notify about NSD and PNFD changes
description: > description: >
The POST method delivers a notification from the API producer to the API consumer. The POST method delivers a notification from the API producer to the API consumer.
This method shall support the URI query parameters, request and This method shall support the URI query parameters, request and
...@@ -396,7 +391,6 @@ paths: ...@@ -396,7 +391,6 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/503" $ref: "../responses/SOL005_resp.yaml#/responses/503"
get: get:
summary: Test the notification endpoint
description: > description: >
The GET method allows the API producer 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. that is provided by the API consumer, e.g. during subscription.
...@@ -469,7 +463,6 @@ paths: ...@@ -469,7 +463,6 @@ paths:
type: string type: string
post: post:
summary: Notify about NSD and PNFD changes
description: > description: >
The POST method delivers a notification from the API producer to the API consumer. The POST method delivers a notification from the API producer to the API consumer.
This method shall support the URI query parameters, request and This method shall support the URI query parameters, request and
...@@ -536,7 +529,6 @@ paths: ...@@ -536,7 +529,6 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/503" $ref: "../responses/SOL005_resp.yaml#/responses/503"
get: get:
summary: Test the notification endpoint
description: > description: >
The GET method allows the API producer 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. that is provided by the API consumer, e.g. during subscription.
...@@ -609,7 +601,6 @@ paths: ...@@ -609,7 +601,6 @@ paths:
type: string type: string
post: post:
summary: Notify about NSD and PNFD changes
description: > description: >
The POST method delivers a notification from the API producer to the API consumer. The POST method delivers a notification from the API producer to the API consumer.
This method shall support the URI query parameters, request and This method shall support the URI query parameters, request and
...@@ -676,7 +667,6 @@ paths: ...@@ -676,7 +667,6 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/503" $ref: "../responses/SOL005_resp.yaml#/responses/503"
get: get:
summary: Test the notification endpoint
description: > description: >
The GET method allows the API producer 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. that is provided by the API consumer, e.g. during subscription.
...@@ -749,7 +739,6 @@ paths: ...@@ -749,7 +739,6 @@ paths:
type: string type: string
post: post:
summary: Notify about NSD and PNFD changes
description: > description: >
The POST method delivers a notification from the API producer to the API consumer. The POST method delivers a notification from the API producer to the API consumer.
This method shall support the URI query parameters, request and This method shall support the URI query parameters, request and
...@@ -816,7 +805,6 @@ paths: ...@@ -816,7 +805,6 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/503" $ref: "../responses/SOL005_resp.yaml#/responses/503"
get: get:
summary: Test the notification endpoint
description: > description: >
The GET method allows the API producer 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. that is provided by the API consumer, e.g. during subscription.
...@@ -889,7 +877,6 @@ paths: ...@@ -889,7 +877,6 @@ paths:
type: string type: string
post: post:
summary: Notify about NSD and PNFD changes
description: > description: >
The POST method delivers a notification from the API producer to the API consumer. The POST method delivers a notification from the API producer to the API consumer.
This method shall support the URI query parameters, request and This method shall support the URI query parameters, request and
...@@ -956,7 +943,6 @@ paths: ...@@ -956,7 +943,6 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/503" $ref: "../responses/SOL005_resp.yaml#/responses/503"
get: get:
summary: Test the notification endpoint
description: > description: >
The GET method allows the API producer 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. that is provided by the API consumer, e.g. during subscription.
......
...@@ -53,7 +53,6 @@ paths: ...@@ -53,7 +53,6 @@ paths:
required: true required: true
type: string type: string
get: get:
summary: Query alarms related to NS instances.
description: > description: >
Get Alarm List. Get Alarm List.
...@@ -183,7 +182,6 @@ paths: ...@@ -183,7 +182,6 @@ paths:
required: true required: true
type: string type: string
get: get:
summary: Read individual alarm.
description: > description: >
The API consumer can use this method to read an individual alarm. 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, 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: ...@@ -249,7 +247,6 @@ paths:
503: 503:
$ref: "../responses/SOL005_resp.yaml#/responses/503" $ref: "../responses/SOL005_resp.yaml#/responses/503"
patch: patch:
summary: Acknowledge individual alarm.
description: > description: >
Acknowledge Alarm Acknowledge Alarm
...@@ -366,7 +363,6 @@ paths: ...@@ -366,7 +363,6 @@ paths:
required: true required: true
type: string type: string
post: post:
summary: Subscribe to alarms related to NSs.
description: > description: >
The POST method creates a new subscription. 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 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: ...@@ -451,7 +447,6 @@ paths:
503: 503:
$ref: "../responses/SOL005_resp.yaml#/responses/503" $ref: "../responses/SOL005_resp.yaml#/responses/503"
get: get:
summary: Query multiple subscriptions.
description: > description: >
Query Subscription Information Query Subscription Information
...@@ -590,7 +585,6 @@ paths: ...@@ -590,7 +585,6 @@ paths:
required: true required: true
type: string type: string
get: get:
summary: Read an individual subscription.
description: > description: >
Query Subscription Information Query Subscription Information
...@@ -659,7 +653,6 @@ paths: ...@@ -659,7 +653,6 @@ paths:
503: 503:
$ref: "../responses/SOL005_resp.yaml#/responses/503" $ref: "../responses/SOL005_resp.yaml#/responses/503"
delete: delete:
summary: Terminate a subscription.
description: > description: >
Terminate Subscription Terminate Subscription
......
...@@ -33,7 +33,6 @@ paths: ...@@ -33,7 +33,6 @@ paths:
################################################################################## ##################################################################################
'/URI_is_provided_by_the_client_when_creating_the_subscription-AlarmNotification': '/URI_is_provided_by_the_client_when_creating_the_subscription-AlarmNotification':
post: post:
summary: Notify about NS alarms
description: > description: >
The POST method notifies an alarm related to a NS or that the alarm list has been rebuilt. 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. The API consumer shall have previously created an "individual subscription resource" with a matching filter.
...@@ -105,7 +104,6 @@ paths: ...@@ -105,7 +104,6 @@ paths:
503: 503:
$ref: "../responses/SOL005_resp.yaml#/responses/503" $ref: "../responses/SOL005_resp.yaml#/responses/503"
get: get:
summary: Test the notification endpoint.
description: > description: >
The GET method allows the server to test the notification endpoint that is provided by The GET method allows the server to test the notification endpoint that is provided by
the API consumer, e.g. during subscription. the API consumer, e.g. during subscription.
...@@ -172,7 +170,6 @@ paths: ...@@ -172,7 +170,6 @@ paths:
'/URI_is_provided_by_the_client_when_creating_the_subscription-AlarmClearedNotification': '/URI_is_provided_by_the_client_when_creating_the_subscription-AlarmClearedNotification':
#ETSI GS NFV-SOL 005 V2.8.1 location: 8.4.6 #ETSI GS NFV-SOL 005 V2.8.1 location: 8.4.6
post: post:
summary: Notify about NS alarms
description: > description: >
The POST method notifies an alarm related to a NS or that the alarm list has been rebuilt. The POST method notifies an alarm related to a NS or that the alarm list has been rebuilt.
parameters: parameters:
...@@ -243,7 +240,6 @@ paths: ...@@ -243,7 +240,6 @@ paths:
503: 503:
$ref: "../responses/SOL005_resp.yaml#/responses/503" $ref: "../responses/SOL005_resp.yaml#/responses/503"
get: get:
summary: Test the notification endpoint.
description: > description: >
The GET method allows the server to test the notification endpoint that is provided by The GET method allows the server to test the notification endpoint that is provided by
the client, e.g. during subscription. the client, e.g. during subscription.
...@@ -309,7 +305,6 @@ paths: ...@@ -309,7 +305,6 @@ paths:
'/URI_is_provided_by_the_client_when_creating_the_subscription-AlarmListRebuiltNotification': '/URI_is_provided_by_the_client_when_creating_the_subscription-AlarmListRebuiltNotification':
post: post:
summary: Notify about NS alarms
description: > description: >
The POST method notifies an alarm related to a NS or that the alarm list has been rebuilt. The POST method notifies an alarm related to a NS or that the alarm list has been rebuilt.
parameters: parameters:
...@@ -380,7 +375,6 @@ paths: ...@@ -380,7 +375,6 @@ paths:
503: 503:
$ref: "../responses/SOL005_resp.yaml#/responses/503" $ref: "../responses/SOL005_resp.yaml#/responses/503"
get: get:
summary: Test the notification endpoint.
description: > description: >
The GET method allows the server to test the notification endpoint that is provided by The GET method allows the server to test the notification endpoint that is provided by
the API consumer, e.g. during subscription. the API consumer, e.g. during subscription.
......
...@@ -52,7 +52,6 @@ paths: ...@@ -52,7 +52,6 @@ paths:
required: true required: true
type: string type: string
post: post:
summary: Create a NS instance resource.
description: > description: >
The POST method creates a new NS instance resource. 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 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: ...@@ -141,7 +140,6 @@ paths:
504: 504:
$ref: "../responses/SOL005_resp.yaml#/responses/504" $ref: "../responses/SOL005_resp.yaml#/responses/504"
get: get:
summary: Query multiple NS instances.
description: > description: >
Query NS Instances. Query NS Instances.
...@@ -316,7 +314,6 @@ paths: ...@@ -316,7 +314,6 @@ paths:
required: true required: true
type: string type: string
get: get:
summary: Read an individual NS instance resource.
description: > description: >
The GET method retrieves information about a NS instance by The GET method retrieves information about a NS instance by
reading an individual NS instance resource. reading an individual NS instance resource.
...@@ -390,7 +387,6 @@ paths: ...@@ -390,7 +387,6 @@ paths:
$ref: "../responses/SOL005_resp.yaml#/responses/504" $ref: "../responses/SOL005_resp.yaml#/responses/504"