Adding http response texts

This change adds the http response texts to the description of responses.
Fixes Bugzilla Bug#37.

Change-Id: Ia4a86e897d95ea132ddef998eac1f66207af7ce7
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>

scripts/jnk_grt_comment.py

@@ -46,6 +46,6 @@ def jenkins_gerrit_comment(change_num, patch_num, comment):
     send_gerrit_comment(change_num+","+patch_num, comment)
 
 def comment_openapis_artifacts(cn, pn, bu):
-    comment = mk_swg_ui_comment("**/*-API.yaml", bu)
+    comment = mk_swg_ui_comment("build/*-API.yaml", bu)
     # print "comment: "+comment
     jenkins_gerrit_comment(str(cn), str(pn), comment)
\ No newline at end of file

src/SOL002/VNFConfiguration/VNFConfiguration.yaml

@@ -41,6 +41,8 @@ paths:
         responses:
           200:
             description: >
+              OK
+
               Configuration information about a VNF instance was read successfully.
               The response body shall contain a representation of the configuration resource.
             schema:
@@ -69,6 +71,8 @@ paths:
         responses:
           200:
             description: >
+              OK
+
               The request was accepted and completed. The response body shall contain the parameters
               of the configuration modification that was applied to the configuration resource.
             schema:

src/SOL002/VNFConfiguration/responses/VNFConfiguration_resp.yaml

 responses:
   409:
     description: >
+      Conflict
+
       Another request is in progress that prohibits the fulfilment of
       the current request, or the current resource state is inconsistent
       with the request.

src/SOL002/VNFFaultManagement/VNFFaultManagement.yaml

@@ -66,6 +66,8 @@ paths:
       responses:
         200:
           description: > 
+            OK
+
             The request has succeeded.
             The response body shall contain the list of related alarms.
           headers:
@@ -145,6 +147,8 @@ paths:
       responses:
         200:
           description: > 
+            OK
+
             Information about an individual alarm was read successfully.
             The response body shall contain a representation of the individual
             alarm.
@@ -214,6 +218,8 @@ paths:
       responses:
         200:
           description: > 
+            OK
+
             The request was accepted and completed. The response body shall
             contain attribute modifications for an ‘Individual alarm’
             resource.
@@ -292,6 +298,8 @@ paths:
       responses:
         201:
           description: > 
+            Created
+
             The subscription was created successfully. The response body shall
             contain a representation of the created subscription resource.
             The HTTP response shall include a "Location:" HTTP header that
@@ -363,6 +371,8 @@ paths:
       responses:
         200:
           description: > 
+            OK
+
             The list of subscriptions was queried successfully. The response
             body shall contain the representations of all active
             subscriptions of the functional block that invokes the method.
@@ -445,6 +455,8 @@ paths:
       responses:
         200:
           description: > 
+            OK
+
             The operation has completed successfully.
             The response body shall contain a representation of the
             subscription resource.
@@ -494,6 +506,8 @@ paths:
       responses:
         204:
           description: > 
+            No Content
+
             The subscription resource was deleted successfully.
             The response body shall be empty.
           headers:

src/SOL002/VNFFaultManagement/responses/VNFFaultManagement_resp.yaml

@@ -4,6 +4,8 @@
 responses:
   409-alarm-state-conflict:
     description: >
+      Conflict
+
       The operation cannot be executed currently, due to a conflict with the
       state of the "Individual alarm" resource.
       Typically, this is due to the fact that the alarm is already in the

src/SOL002/VNFIndicator/VNFIndicator.yaml

@@ -102,6 +102,8 @@ paths:
         responses:
           200:
             description: >
+              OK
+
               The list of VNF indicators was queried successfully.
               The response body shall contain the representations of all VNF indicators that match
               the attribute-based filtering parameters.
@@ -127,6 +129,8 @@ paths:
        - name: vnfInstanceId
          in: path
          description: >
+           Service Unavailable
+
            Identifier of the VNF instance to which the VNF indicators applies.
            NOTE: This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a 
            POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body 
@@ -189,6 +193,8 @@ paths:
         responses:
           200:
             description: >
+              OK
+
               The list of VNF indicators was queried successfully.
               The response body shall contain the representations of all VNF indicators that match
               the attribute-based filtering parameters.
@@ -214,6 +220,8 @@ paths:
        - name: vnfInstanceId
          in: path
          description: >
+           Service Unavailable
+
            Identifier of the VNF instance to which the VNF indicators applies.
            NOTE: This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a 
            POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body 
@@ -237,6 +245,8 @@ paths:
         responses:
           200:
             description: >
+              OK
+
               The VNF indicator was read successfully.
               The response body shall contain the representation of the VNF indicator.
             schema:
@@ -268,6 +278,8 @@ paths:
         responses:
           201:
             description: >
+              Created
+
               The subscription was created successfully.
               The response body shall contain a representation of the created subscription resource.
             schema:
@@ -292,6 +304,8 @@ paths:
       get:
         summary: Query multiple subscriptions.
         description: >
+          Service Unavailable
+
           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.
 #        parameters:
@@ -368,6 +382,8 @@ paths:
         responses:
           200:
             description: >
+              OK
+
               The list of subscriptions was queried successfully. The response body shall contain
               the representations of all active subscriptions of the functional block that invokes
               the method which match the attribute filter.
@@ -392,6 +408,8 @@ paths:
       get:
         summary: Read an individual subscription.
         description: >
+          Service Unavailable
+
           This resource represents an individual subscription. The client can use this resource to 
           read and to terminate a subscription to notifications related to VNF indicator value changes.
         parameters:
@@ -408,6 +426,8 @@ paths:
         responses:
           200:
             description: >
+              OK
+
               The subscriptions was queried successfully. The response body shall contain
               the representation of the requested subscription.
             schema:
@@ -429,6 +449,8 @@ paths:
         parameters:
          - name: subscriptionId
            description: >
+             Service Unavailable
+
              Identifier of this subscription.
              NOTE:
               This identifier can be retrieved from the resource referenced by the "Location" HTTP header
@@ -440,6 +462,8 @@ paths:
         responses:
           204:
             description: >
+              No Content
+
               The subscription was deleted successfully.
               The response body shall be empty.
           400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' }

src/SOL002/VNFIndicator/responses/VNFIndicator_resp.yaml

 responses:
   409:
     description: >
+      Conflict
+
       Another request is in progress that prohibits the fulfilment of
       the current request, or the current resource state is inconsistent
       with the request.

src/SOL002/VNFIndicatorNotification/VNFIndicatorNotification.yaml

@@ -54,6 +54,8 @@ paths:
         responses:
           204:
             description: >
+              No Content
+
               The notification was delivered successfully. The response body shall be empty.
           400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' }
           401: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' }
@@ -69,11 +71,15 @@ paths:
       get:
         summary: Test notification endpoint.
         description: >
+          Service Unavailable
+
           The GET method allows the server to test the notification endpoint that is provided
           by the client, e.g. during subscription.
         responses:
           204:
             description: >
+              No Content
+
               The notification endpoint was tested successfully. The response body shall be empty.
           400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' }
           401: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' }

src/SOL002/VNFIndicatorNotification/responses/VNFIndicatorNotification_resp.yaml

 responses:
   409:
     description: >
+      Conflict
+
       Another request is in progress that prohibits the fulfilment of
       the current request, or the current resource state is inconsistent
       with the request.

src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml

@@ -84,6 +84,8 @@ paths:
               format: url
             WWW-Authenticate:
               description: >
+                Created
+
                 Challenge if the corresponding HTTP request has not provided
                 authorization, or error details if the corresponding HTTP
                 request has provided an invalid authorization token.
@@ -135,6 +137,8 @@ paths:
       responses:
         200:
           description: > 
+            OK
+
             Information about zero or more VNF instances was queried
             successfully. The response body shall contain
             representations of zero or more VNF instances.
@@ -198,6 +202,8 @@ paths:
       responses:
         200:
           description: > 
+            OK
+
             Information about zero or more VNF instances was queried
             successfully. The response body shall contain
             representations of zero or more VNF instances.
@@ -283,6 +289,8 @@ paths:
       responses:
         204:
           description: > 
+            No Content
+
             The VNF instance resource and the associated VNF identifier were
             deleted successfully.
             The response body shall be empty.
@@ -345,6 +353,8 @@ paths:
       responses:
         200:
           description: > 
+            OK
+
             Information about zero or more VNF instances was queried
             successfully. The response body shall contain
             representations of zero or more VNF instances.
@@ -401,6 +411,8 @@ paths:
       responses:
         200:
           description: > 
+            OK
+
             Information about zero or more VNF instances was queried
             successfully. The response body shall contain
             representations of zero or more VNF instances.
@@ -507,6 +519,8 @@ paths:
       responses:
         204:
           description: > 
+            No Content
+
             The VNF instance resource and the associated VNF identifier were
             deleted successfully.
             The response body shall be empty.
@@ -887,6 +901,8 @@ paths:
       responses:
         200:
           description: >
+            OK
+
             Status information for zero or more VNF lifecycle management
             operation occurrences was queried successfully. The response body
             shall contain status information about zero or more VNF lifecycle
@@ -951,6 +967,8 @@ paths:
       responses:
         200:
           description: >
+            OK
+
             Information about an individual VNF instance was queried
             successfully. The response body shall contain status
             information about a VNF lifecycle management operation
@@ -1101,6 +1119,8 @@ paths:
       responses:
         200:
           description: > 
+            OK
+
             The state of the VNF lifecycle management operation occurrence was
             changed successfully. The response shall include a representation
             of the VNF lifecycle operation occurrence resource.
@@ -1178,6 +1198,8 @@ paths:
           $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406"
         409:
           description: > 
+            Conflict
+
             The operation cannot be executed currently, due to a conflict with
             the state of the VNF LCM operation occurrence resource.
             Typically, this is due to the fact that the operation occurrence
@@ -1224,6 +1246,8 @@ paths:
       responses:
         201:
           description: > 
+            Created
+
             The subscription was created successfully. The response body shall
             contain a representation of the created subscription resource.
             The HTTP response shall include a "Location" HTTP header that
@@ -1272,6 +1296,8 @@ paths:
       responses:
         200:
           description: > 
+            OK
+
             The list of subscriptions was queried successfully. The response
             body shall contain the representations of all active subscriptions
             of the functional block that invokes the method.
@@ -1293,6 +1319,8 @@ paths:
             $ref: "../../definitions/SOL002SOL003VNFLifecycleManagement_def.yaml#/definitions/LccnSubscription"
         400:
           description: > 
+            Bad Request
+
             Invalid attribute-based filtering parameters.
             The response body shall contain a ProblemDetails structure, in
             which the "detail" attribute should convey more information about
@@ -1350,6 +1378,8 @@ paths:
       responses:
         200:
           description: > 
+            OK
+
             The operation has completed successfully.
             The response body shall contain a representation of the
             subscription resource.
@@ -1391,6 +1421,8 @@ paths:
       responses:
         204:
           description: > 
+            No Content
+
             The subscription resource was deleted successfully.
             The response body shall be empty.
           headers:

src/SOL002/VNFLifecycleManagement/responses/VNFLifecycleManagement_resp.yaml

@@ -4,6 +4,8 @@
 responses:
   202-with-Location:
     description: > 
+      Accepted
+
       The request was accepted for processing, but the processing has not
       been completed. On success, the HTTP response shall include a
       "Location" HTTP header that contains the URI of the newly-created
@@ -31,6 +33,8 @@ responses:
       $ref: "../definitions/VNFLifecycleManagement_def.yaml#/definitions/VnfInstance"
   409-another-lcm-operation-ongoing:
     description: >
+      Conflict
+
       The operation cannot be executed currently, due to a conflict with the
       state of the VNF instance resource.
       Typically, this is due to the fact that another LCM operation is
@@ -55,6 +59,8 @@ responses:
       $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
   409-inconsistent-state:
     description: >
+      Conflict
+
       Another request is in progress that prohibits the fulfilment of
       the current request, or the current resource state is inconsistent
       with the request.
@@ -76,6 +82,8 @@ responses:
       $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
   409-state-conflict-INSTANTIATED:
     description: >
+      Conflict
+
       The operation cannot be executed currently, due to a conflict with the
       state of the VNF instance resource.
       Typically, this is due to the fact that the VNF instance resource is in
@@ -125,6 +133,8 @@ responses:
       $ref: "../../../definitions/SOL002SOL003_def.yaml#/definitions/ProblemDetails"
   409-state-conflict-NOT-INSTANTIATED:
     description: >
+      Conflict
+
       The operation cannot be executed currently, due to a conflict with the
       state of the VNF instance resource.
       Typically, this is due to the fact that the VNF instance resource is in

src/SOL002/VNFPerformanceManagement/VNFPerformanceManagement.yaml

@@ -71,6 +71,8 @@ paths:
       responses:
         201:
           description: > 
+            Created
+
             The PM job was created successfully. The response body shall
             contain a representation of the created PM job resource.
             The HTTP response shall include a "Location" HTTP header that
@@ -132,6 +134,8 @@ paths:
       responses:
         200:
           description: > 
+            OK
+
             Information about zero or more PM jobs was queried successfully.
             The response body shall contain representations of zero or more PM
             jobs.
@@ -199,6 +203,8 @@ paths:
       responses:
         200:
           description: > 
+            OK
+
             Information about an individual PM job was queried successfully.
             The response body shall contain a representation of the PM job
             resource.
@@ -241,6 +247,8 @@ paths:
       responses:
         204:
           description: > 
+            No Content
+
             The PM job was deleted successfully.
             The response body shall be empty.
           headers:
@@ -306,6 +314,8 @@ paths:
       responses:
         200:
           description: > 
+            OK
+
             Information of an individual performance report was read
             successfully.
             The response body shall contain a representation of the
@@ -375,6 +385,8 @@ paths:
       responses:
         201:
           description: > 
+            Created
+
             A threshold was created successfully. The response body shall
             contain a representation of the created threshold resource.
             The HTTP response shall include a "Location" HTTP header that
@@ -429,6 +441,8 @@ paths:
       responses:
         200:
           description: > 
+            OK
+
             Information about zero or more thresholds was queried
             successfully.
             The response body shall contain representations of zero
@@ -501,6 +515,8 @@ paths:
       responses:
         200:
           description: > 
+            OK
+
             Information about an individual threshold was queried
             successfully. The response body shall contain a
             representation of the threshold.
@@ -550,6 +566,8 @@ paths:
       responses:
         204:
           description: > 
+            No Content
+
             The threshold was deleted successfully.
             The response body shall be empty.
           headers:
@@ -615,6 +633,8 @@ paths:
       responses:
         201:
           description: > 
+            Created
+
             The subscription was created successfully. A representation of the
             created subscription resource shall be returned in the response
             body.
@@ -672,6 +692,8 @@ paths:
       responses:
         200:
           description: > 
+            OK
+
             The list of subscriptions was queried successfully.
             The response body shall contain the representations of all active
             subscriptions of the functional block that invokes the method.
@@ -746,6 +768,8 @@ paths:
       responses:
         200:
           description: > 
+            OK
+
             The subscription was read successfully. The response body shall
             contain a representation of the subscription resource.
           headers:
@@ -801,6 +825,8 @@ paths:
       responses:
         204:
           description: > 
+            No Content
+
             The subscription resource was deleted successfully.
             The response body shall be empty.
           headers:

src/SOL003/VNFFaultManagement/VNFFaultManagement.yaml

@@ -66,6 +66,8 @@ paths:
       responses:
         200:
           description: > 
+            OK
+
             The request has succeeded.
             The response body shall contain the list of related alarms.
           headers:
@@ -137,6 +139,8 @@ paths:
       responses:
         200:
           description: > 
+            OK
+
             Information about an individual alarm was read successfully.
             The response body shall contain a representation of the individual
             alarm.
@@ -200,6 +204,8 @@ paths:
       responses:
         200:
           description: > 
+            OK
+
             The request was accepted and completed. The response body shall
             contain attribute modifications for an ‘Individual alarm’
             resource.
@@ -280,6 +286,8 @@ paths:
       responses:
         201:
           description: > 
+            Created
+
             The subscription was created successfully. The response body shall
             contain a representation of the created subscription resource.
             The HTTP response shall include a "Location:" HTTP header that
@@ -345,6 +353,8 @@ paths:
       responses:
         200:
           description: > 
+            OK
+
             The list of subscriptions was queried successfully. The response
             body shall contain the representations of all active
             subscriptions of the functional block that invokes the method.
@@ -419,6 +429,8 @@ paths:
       responses:
         200:
           description: > 
+            OK
+
             The operation has completed successfully.
             The response body shall contain a representation of the
             subscription resource.
@@ -460,6 +472,8 @@ paths:
       responses:
         204:
           description: > 
+            No Content
+
             The subscription resource was deleted successfully.
             The response body shall be empty.
           headers:

src/SOL003/VNFFaultManagement/responses/VNFFaultManagement_resp.yaml

 responses:
   409-alarm-state-conflict:
     description: >
+      Conflict
+
       The operation cannot be executed currently, due to a conflict with the
       state of the "Individual alarm" resource.
       Typically, this is due to the fact that the alarm is already in the

src/SOL003/VNFFaultManagementNotification/VNFFaultManagementNotification.yaml

@@ -54,6 +54,8 @@ paths:
       responses:
         204:
           description: > 
+            No Content
+
             The notification was delivered successfully.