diff --git a/src/SOL003/VNFFaultManagement/VNFFaultManagement.yaml b/src/SOL003/VNFFaultManagement/VNFFaultManagement.yaml index c139d3d28bdfefbd6d3cbe522c09c94f415ea600..d74b227ec1c92d57039be7692f98961c84adc4b4 100644 --- a/src/SOL003/VNFFaultManagement/VNFFaultManagement.yaml +++ b/src/SOL003/VNFFaultManagement/VNFFaultManagement.yaml @@ -46,6 +46,9 @@ paths: #SOL003 location: 7.4.2 get: description: > + Get Alarm List + + The client can use this method to retrieve information about the alarm list. parameters: @@ -170,6 +173,9 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" patch: description: > + Acknowledge Alarm + + This method modifies an individual alarm resource. parameters: - name: AlarmModifications @@ -252,6 +258,9 @@ paths: #SOL003 location: 7.4.4 post: description: > + Subscribe + + The POST method creates a new subscription. Creation of two subscription resources with the same callbackURI and the same filter can result in performance degradation and will @@ -341,6 +350,9 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" get: description: > + Query Subscription Information + + The client can use this method to retrieve the list of active subscriptions for VNF alarms subscribed by the client. It can be used e.g. for resynchronization after error situations. @@ -426,6 +438,9 @@ paths: required: true get: description: > + Query Subscription Information + + The client can use this method for reading an individual subscription for VNF alarms subscribed by the client. parameters: @@ -492,6 +507,9 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" delete: description: > + Terminate Subscription + + This method terminates an individual subscription. parameters: - name: Authorization diff --git a/src/SOL003/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml b/src/SOL003/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml index 5650e75a3687afe97bfe595b5acfe1e63b101c6f..7998261ae94cb9c17a1d9d49776174431b214242 100644 --- a/src/SOL003/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml +++ b/src/SOL003/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml @@ -46,6 +46,9 @@ paths: #SOL003 location: 7.4.6 post: description: > + Notify + + The POST method notifies a VNF alarm or that the alarm list has been rebuilt. parameters: @@ -150,6 +153,9 @@ paths: #SOL003 location: 7.4.6 post: description: > + Notify + + The POST method notifies a VNF alarm or that the alarm list has been rebuilt. parameters: @@ -254,6 +260,9 @@ paths: #SOL003 location: 7.4.6 post: description: > + Notify + + The POST method notifies a VNF alarm or that the alarm list has been rebuilt. parameters: diff --git a/src/SOL003/VNFIndicator/VNFIndicator.yaml b/src/SOL003/VNFIndicator/VNFIndicator.yaml index 9be5d47412ea2abe3c75cb8334a9b5b95d7d1c14..ae204ac570bed2c971a0c6f28b209a7820ae1551 100644 --- a/src/SOL003/VNFIndicator/VNFIndicator.yaml +++ b/src/SOL003/VNFIndicator/VNFIndicator.yaml @@ -45,6 +45,9 @@ paths: #SOL003 location: 8.4.2 get: description: > + Get Indicator Value + + The GET method queries multiple VNF indicators. parameters: - name: Accept @@ -121,6 +124,9 @@ paths: required: true get: description: > + Get Indicator Value + + The GET method queries multiple VNF indicators related to a VNF instance. parameters: @@ -215,6 +221,9 @@ paths: required: true get: description: > + Get Indicator Value + + The GET method reads a VNF indicator. parameters: - name: Accept @@ -284,6 +293,9 @@ paths: '/subscriptions': post: description: > + Subscribe + + The POST method creates a new subscription. Creation of two subscription resources with the same callbackURI and the same filter can result in performance degradation and will provide @@ -375,6 +387,9 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" get: description: > + Query Subscription Information + + 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. @@ -465,6 +480,9 @@ paths: required: true get: description: > + Query Subscription Information + + The GET method reads an individual subscription. parameters: - name: Accept @@ -530,6 +548,9 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" delete: description: > + Terminate Subscription + + The DELETE method terminates an individual subscription. parameters: - name: Authorization diff --git a/src/SOL003/VNFIndicatorNotification/VNFIndicatorNotification.yaml b/src/SOL003/VNFIndicatorNotification/VNFIndicatorNotification.yaml index 6983708f8f274743242bb595849a4dc54b36ac9b..67455142e403b16e940d2a57b8de16029d77e491 100644 --- a/src/SOL003/VNFIndicatorNotification/VNFIndicatorNotification.yaml +++ b/src/SOL003/VNFIndicatorNotification/VNFIndicatorNotification.yaml @@ -46,6 +46,9 @@ paths: #SOL003 location: 8.4.7 post: description: > + Notify + + The POST method notifies a VNF alarm or that the alarm list has been rebuilt. parameters: diff --git a/src/SOL003/VNFLifecycleManagement/VNFLifecycleManagement.yaml b/src/SOL003/VNFLifecycleManagement/VNFLifecycleManagement.yaml index ea31bc6b56aaf756a53f2de0611ec85186cd2bf7..2d63c7afeaa81abf667b2c47ad4fec43f5c1faa4 100644 --- a/src/SOL003/VNFLifecycleManagement/VNFLifecycleManagement.yaml +++ b/src/SOL003/VNFLifecycleManagement/VNFLifecycleManagement.yaml @@ -45,7 +45,12 @@ paths: '/vnf_instances': #SOL003 location: 5.4.2 post: - description: "The POST method creates a new VNF instance resource." + #TODO: Add headers defined in 4.3.4.2 + description: > + Create VNF Identifier + + + The POST method creates a new VNF instance resource. parameters: - name: createVnfRequest description: The VNF creation parameters @@ -121,6 +126,9 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" get: description: > + Query VNF + + The GET method queries information about multiple VNF instances. parameters: - name: Accept @@ -201,6 +209,9 @@ paths: required: true get: description: > + Query VNF + + The GET method retrieves information about a VNF instance by reading an individual VNF instance resource. parameters: @@ -272,6 +283,9 @@ paths: patch: #SOL003 location: 5.4.3.3.4 description: > + Modify VNF Information + + 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 @@ -327,6 +341,9 @@ paths: delete: #SOL003 location: 5.4.3.3.5 description: > + Delete VNF Identifier + + This method deletes an individual VNF instance resource. parameters: - name: Authorization @@ -392,6 +409,9 @@ paths: post: #SOL003 location: 5.4.4.3.1 description: > + Instantiate VNF + + The POST method instantiates a VNF instance. parameters: - name: InstantiateVnfRequest @@ -484,6 +504,9 @@ paths: post: #SOL003 location: 5.4.5.3.1 description: > + Scale VNF + + The POST method requests to scale a VNF instance resource incrementally. parameters: @@ -554,6 +577,9 @@ paths: post: #SOL003 location: 5.4.6.3.1 description: > + Scale VNF to Level + + The POST method requests to scale a VNF instance resource to a target level. parameters: @@ -624,6 +650,9 @@ paths: required: true post: description: > + Change VNF Flavour + + The POST method changes the deployment flavour of a VNF instance. parameters: - name: ChangeVnfFlavourRequest @@ -692,6 +721,9 @@ paths: required: true post: description: > + Terminate VNF + + The POST method terminates a VNF instance. parameters: - name: TerminateVnfRequest @@ -760,6 +792,9 @@ paths: required: true post: description: > + Heal VNF + + The POST method requests to heal a VNF instance resource. parameters: - name: HealVnfRequest @@ -828,6 +863,9 @@ paths: required: true post: description: > + Operate VNF + + The POST method changes the operational state of a VNF instance resource. parameters: - name: OperateVnfRequest @@ -897,6 +935,9 @@ paths: required: true post: description: > + Change External VNF Connectivity + + The POST method changes the external connectivity of a VNF instance. parameters: - name: ChangeExtVnfConnectivityRequest @@ -955,6 +996,9 @@ paths: #SOL003 location: 5.4.12 get: description: > + Get Operation Status + + The client can use this method to query status information about multiple VNF lifecycle management operation occurrences. parameters: @@ -1034,6 +1078,9 @@ paths: type: string get: description: > + Get Operation Status + + The client can use this method to retrieve status information about a VNF lifecycle management operation occurrence by reading an individual "VNF LCM operation occurrence" resource. @@ -1360,6 +1407,9 @@ paths: #SOL003 location: 5.4.18 post: description: > + Subscribe + + The POST method creates a new subscription. Creation of two subscription resources with the same callbackURI and the same filter can result in performance degradation and will provide @@ -1470,6 +1520,9 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" get: description: > + Query Subscription Information + + 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. @@ -1568,6 +1621,9 @@ paths: required: true get: description: > + Query Subscription Information + + The GET method retrieves information about a subscription by reading an individual subscription resource. parameters: @@ -1627,6 +1683,9 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" delete: description: > + Terminate Subscription + + The DELETE method terminates an individual subscription. parameters: - name: Authorization diff --git a/src/SOL003/VNFLifecycleManagementNotification/VNFLifecycleManagementNotification.yaml b/src/SOL003/VNFLifecycleManagementNotification/VNFLifecycleManagementNotification.yaml index f4b50173c0d1ed3241f6706e7544b410b83db787..eda2225de801db47aa1794ec83eb8c789f67e356 100644 --- a/src/SOL003/VNFLifecycleManagementNotification/VNFLifecycleManagementNotification.yaml +++ b/src/SOL003/VNFLifecycleManagementNotification/VNFLifecycleManagementNotification.yaml @@ -45,6 +45,9 @@ paths: '/URI-is-provided-by-the-client-when-creating-the-subscription-VnfLcmOperationOccurrenceNotification': post: description: > + Notify + + The POST method delivers a notification from the server to the client. parameters: - name: VnfLcmOperationOccurrenceNotification @@ -104,6 +107,9 @@ paths: '/URI-is-provided-by-the-client-when-creating-the-subscription-VnfIdentifierCreationNotification': post: description: > + Notify + + The POST method delivers a notification from the server to the client. parameters: - name: VnfIdentifierCreationNotification @@ -165,6 +171,9 @@ paths: '/URI-is-provided-by-the-client-when-creating-the-subscription-VnfIdentifierDeletionNotification': post: description: > + Notify + + The POST method delivers a notification from the server to the client. parameters: - name: VnfIdentifierDeletionNotification diff --git a/src/SOL003/VNFLifecycleOperationGranting/VNFLifecycleOperationGranting.yaml b/src/SOL003/VNFLifecycleOperationGranting/VNFLifecycleOperationGranting.yaml index 9330509cf5006405c32a25af5227d959051ea364..62b6a73b3de5cb801ff053bd5e8ee17dd1bdc842 100644 --- a/src/SOL003/VNFLifecycleOperationGranting/VNFLifecycleOperationGranting.yaml +++ b/src/SOL003/VNFLifecycleOperationGranting/VNFLifecycleOperationGranting.yaml @@ -46,6 +46,9 @@ paths: #SOL003 location: 9.4.2 post: description: > + Grant Lifecycle Operation + + The POST method requests a grant for a particular VNF lifecycle operation. parameters: @@ -189,6 +192,9 @@ paths: required: true get: description: > + Grant Lifecycle Operation + + The GET method retrieves information about a specific grant by reading an individual grant resource. parameters: diff --git a/src/SOL003/VNFPackageManagement/VNFPackageManagement.yaml b/src/SOL003/VNFPackageManagement/VNFPackageManagement.yaml index 9be18cb0554c134adbd8044010c5585e136d44cb..27d7f3beeb71d29ba6300dc3585e9bd63bc70bcd 100644 --- a/src/SOL003/VNFPackageManagement/VNFPackageManagement.yaml +++ b/src/SOL003/VNFPackageManagement/VNFPackageManagement.yaml @@ -46,6 +46,9 @@ paths: #SOL003 location: 10.4.2 get: description: > + Query VNF Package Info + + The GET method queries the information of the VNF packages matching the filter. parameters: @@ -122,6 +125,9 @@ paths: required: true get: description: > + Query VNF Package Info + + The GET method reads the information of an individual VNF package. parameters: - name: Accept @@ -195,6 +201,9 @@ paths: required: true get: description: > + Query VNF Package Info + + The GET method reads the content of the VNFD within a VNF package. The VNFD can be implemented as a single file or as a collection of multiple files. If the VNFD is implemented in the form of multiple @@ -304,6 +313,9 @@ paths: required: true get: description: > + Fetch VNF Package + + The GET method fetches the content of a VNF package identified by the VNF package identifier allocated by the NFVO. parameters: @@ -434,6 +446,9 @@ paths: required: true get: description: > + Fetch VNF Package Artifacts + + The GET method fetches the content of an artifact within a VNF package. parameters: @@ -547,6 +562,9 @@ paths: '/subscriptions': post: description: > + Subscribe + + The POST method creates a new subscription. Creation of two subscription resources with the same callbackURI and the same filter can result in performance degradation and will provide @@ -641,6 +659,9 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" get: description: > + Query Subscription Information + + 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. @@ -720,6 +741,9 @@ paths: required: true get: description: > + Query Subscription Information + + The GET method reads an individual subscription. parameters: - name: Accept @@ -778,6 +802,9 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" delete: description: > + Terminate subscription + + The DELETE method terminates an individual subscription. parameters: - name: Authorization diff --git a/src/SOL003/VNFPackageManagementNotification/VNFPackageManagementNotification.yaml b/src/SOL003/VNFPackageManagementNotification/VNFPackageManagementNotification.yaml index def8a23d148773ad2062bf2fb1e918687b7d4a0d..517ef879380a7f647e33ecce1a98e391ab60e344 100644 --- a/src/SOL003/VNFPackageManagementNotification/VNFPackageManagementNotification.yaml +++ b/src/SOL003/VNFPackageManagementNotification/VNFPackageManagementNotification.yaml @@ -46,6 +46,9 @@ paths: #SOL003 location: 10.4.9 post: description: > + Notify + + The POST method delivers a notification from the server to the client. parameters: - name: VnfPackageOnboardingNotification @@ -146,6 +149,9 @@ paths: #SOL003 location: 10.4.9 post: description: > + Notify + + The POST method delivers a notification from the server to the client. parameters: - name: VnfPackageChangeNotification diff --git a/src/SOL003/VNFPerformanceManagement/VNFPerformanceManagement.yaml b/src/SOL003/VNFPerformanceManagement/VNFPerformanceManagement.yaml index 1a6b0c7354135faf187d973ef17166e6ee871ee4..cecaedae9486adbd37b833993c00dc688c9483e0 100644 --- a/src/SOL003/VNFPerformanceManagement/VNFPerformanceManagement.yaml +++ b/src/SOL003/VNFPerformanceManagement/VNFPerformanceManagement.yaml @@ -46,6 +46,9 @@ paths: #SOL003 location: 6.4.2 post: description: > + Create PM Job + + The POST method creates a PM job. parameters: - name: CreatePmJobRequest @@ -115,6 +118,9 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" get: description: > + Query PM Job + + The client can use this method to retrieve information about PM jobs. parameters: - name: Accept @@ -191,6 +197,9 @@ paths: required: true get: description: > + Query PM Job + + The client can use this method for reading an individual PM job. parameters: - name: Accept @@ -249,6 +258,9 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" delete: description: > + Delete PM Job + + This method terminates an individual PM job. parameters: - name: Authorization @@ -373,6 +385,9 @@ paths: #SOL003 location: 6.4.5 post: description: > + Create Threshold + + The POST method can be used by the client to create a threshold. parameters: - name: CreateThresholdRequest @@ -450,6 +465,9 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" get: description: > + Query Threshold + + The client can use this method to query information about thresholds. parameters: - name: Accept @@ -531,6 +549,9 @@ paths: required: true get: description: > + Query Threshold + + The client can use this method for reading an individual threshold. parameters: - name: Accept @@ -589,6 +610,9 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" delete: description: > + Delete Threshold + + This method allows to delete a threshold. parameters: - name: Authorization @@ -635,6 +659,9 @@ paths: #SOL003 location: 6.4.7 post: description: > + Subscribe + + The POST method creates a new subscription. Creation of two subscription resources with the same callbackURI and the same filter can result in performance degradation and will provide @@ -725,6 +752,9 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" get: description: > + Query Subscription Information + + The client can use this method to query the list of active subscriptions to Performance management notifications subscribed by the client. @@ -802,6 +832,9 @@ paths: required: true get: description: > + Query Subscription Information + + The client can use this method for reading an individual subscription about Performance management notifications subscribed by the client. parameters: @@ -860,6 +893,9 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" delete: description: > + Terminate Subscription + + This method terminates an individual subscription. parameters: - name: Authorization diff --git a/src/SOL003/VNFPerformanceManagementNotification/VNFPerformanceManagementNotification.yaml b/src/SOL003/VNFPerformanceManagementNotification/VNFPerformanceManagementNotification.yaml index fd8035918ccd90b0020e8c9937ec83d090ffb0f7..163097ea065eb165afbb71421c06214ddcd94fa0 100644 --- a/src/SOL003/VNFPerformanceManagementNotification/VNFPerformanceManagementNotification.yaml +++ b/src/SOL003/VNFPerformanceManagementNotification/VNFPerformanceManagementNotification.yaml @@ -46,6 +46,9 @@ paths: #SOL003 location: 6.4.9 post: description: > + Notify + + The POST method delivers a notification regarding a performance management event from the server to the client. parameters: @@ -147,6 +150,9 @@ paths: #SOL003 location: 6.4.9 post: description: > + Notify + + The POST method delivers a notification regarding a performance management event from the server to the client. parameters: diff --git a/src/SOL003/VirtualisedResourcesQuotaAvailableNotification/VirtualisedResourcesQuotaAvailableNotification.yaml b/src/SOL003/VirtualisedResourcesQuotaAvailableNotification/VirtualisedResourcesQuotaAvailableNotification.yaml index 01a976d22a02cacfb740ef7b7f647392163266e3..13c9fc21e6b4f38358e272c9c86b2fa833b5594a 100644 --- a/src/SOL003/VirtualisedResourcesQuotaAvailableNotification/VirtualisedResourcesQuotaAvailableNotification.yaml +++ b/src/SOL003/VirtualisedResourcesQuotaAvailableNotification/VirtualisedResourcesQuotaAvailableNotification.yaml @@ -45,6 +45,9 @@ paths: '/subscriptions': post: description: > + Subscribe + + The POST method creates a new subscription. Creation of two subscription resources with the same callbackURI and the same filter can result in performance degradation and will provide @@ -133,6 +136,9 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" get: description: > + Query Subscription Information + + The GET method allows the server to test the notification endpoint that is provided by the client, e.g. during subscription. parameters: diff --git a/src/SOL003/VirtualisedResourcesQuotaAvailableNotificationNotification/VirtualisedResourcesQuotaAvailableNotificationNotification.yaml b/src/SOL003/VirtualisedResourcesQuotaAvailableNotificationNotification/VirtualisedResourcesQuotaAvailableNotificationNotification.yaml index cdfe624d28eec7c32a1a8ab055b9557cde00ac8d..f80576eb31dd014e6aa32f9d4dbc0246700dec7f 100644 --- a/src/SOL003/VirtualisedResourcesQuotaAvailableNotificationNotification/VirtualisedResourcesQuotaAvailableNotificationNotification.yaml +++ b/src/SOL003/VirtualisedResourcesQuotaAvailableNotificationNotification/VirtualisedResourcesQuotaAvailableNotificationNotification.yaml @@ -45,6 +45,9 @@ paths: '/URI-is-provided-by-the-client-when-creating-the-subscription': post: description: > + Notify + + The POST method delivers a notification from the server to the client. parameters: - name: VrQuotaAvailNotification