Skip to content
GitLab
Find file Normal viewHistoryPermalink
VNFPackageManagement.yaml 49 KB
Newer Older
rameshnaraya's avatar
SOL005 2.4.1 - Fixed reference issues in spec files, generated while building Jenkins script.  
rameshnaraya committed
1001 1002 
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP
rameshnaraya's avatar
Merge Request issue.  
rameshnaraya committed
1003 
                request has provided an invalid authorization token.
rameshnaraya's avatar
SOL005 2.4.1 - Fixed reference issues in spec files, generated while building Jenkins script.  
rameshnaraya committed
1004 1005 1006 
          schema:
            type: array
            items:
rameshnaraya's avatar
Merge Request issue.  
rameshnaraya committed
1007 1008 1009 
              properties:
                PkgmSubscription:
                  $ref: "definitions/SOL005VNFPMManagement_def.yaml#/definitions/PkgmSubscription"
rameshnaraya's avatar
SOL005 2.4.1 - Fixed reference issues in spec files, generated while building Jenkins script.  
rameshnaraya committed
1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "responses/SOL005_resp.yaml#/responses/404"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"
          
###############################################################################
# Individual subscription                                                     #
###############################################################################
  '/subscriptions/{subscriptionId}':
    #SOL003 location: 10.4.8
    parameters:
      - name: subscriptionId
        description: >
          Identifier of this subscription.
          This identifier can be retrieved from the resource referenced by
          the "Location" HTTP header in the response to a POST request
          creating a new subscription resource. It can also be retrieved from
          the "id" attribute in the payload body of that response.
        in: path
        type: string
        required: true
    get:
      summary: >
rameshnaraya's avatar
Merge Request issue.  
rameshnaraya committed
1047 
        Read an individual subscription resource.
rameshnaraya's avatar
SOL005 2.4.1 - Fixed reference issues in spec files, generated while building Jenkins script.  
rameshnaraya committed
1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 
      description: >
        Query Subscription Information
        The GET method reads an individual subscription.
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
      responses:
        200:
rameshnaraya's avatar
Merge Request issue.  
rameshnaraya committed
1068 1069 1070 
          description: >
            200 OK.
rameshnaraya's avatar
SOL005 2.4.1 - Fixed reference issues in spec files, generated while building Jenkins script.  
rameshnaraya committed
1071 1072 1073 1074 1075 1076 1077 1078 
            Representation of the subscription resource.
          headers:
            Content-Type:
              description: The MIME type of the body of the response.
              type: string
              maximum: 1
              minimum: 1
            WWW-Authenticate:
rameshnaraya's avatar
Merge Request issue.  
rameshnaraya committed
1079 
              type: string
rameshnaraya's avatar
SOL005 2.4.1 - Fixed reference issues in spec files, generated while building Jenkins script.  
rameshnaraya committed
1080 1081 1082 
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP
rameshnaraya's avatar
Merge Request issue.  
rameshnaraya committed
1083 
                request has provided an invalid authorization token.
rameshnaraya's avatar
SOL005 2.4.1 - Fixed reference issues in spec files, generated while building Jenkins script.  
rameshnaraya committed
1084 
          schema:
rameshnaraya's avatar
Merge Request issue.  
rameshnaraya committed
1085 1086 1087 
            properties:
              NsdInfo:
                $ref: "definitions/SOL005VNFPMManagement_def.yaml#/definitions/PkgmSubscription"
rameshnaraya's avatar
SOL005 2.4.1 - Fixed reference issues in spec files, generated while building Jenkins script.  
rameshnaraya committed
1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "responses/SOL005_resp.yaml#/responses/404"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"
    delete:
      summary: >
rameshnaraya's avatar
Merge Request issue.  
rameshnaraya committed
1108 1109 
        Terminate a subscription.
      description: >
rameshnaraya's avatar
SOL005 2.4.1 - Fixed reference issues in spec files, generated while building Jenkins script.  
rameshnaraya committed
1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 
        The DELETE method terminates an individual subscription.
      parameters:
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
      responses:
        204:
          description: >
rameshnaraya's avatar
Merge Request issue.  
rameshnaraya committed
1122 
            No Content.
rameshnaraya's avatar
SOL005 2.4.1 - Fixed reference issues in spec files, generated while building Jenkins script.  
rameshnaraya committed
1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 

            The subscription resource was deleted successfully.
          headers:
            WWW-Authenticate:
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP
                request has provided an invalid authorization token.
              type: string
              maximum: 1
              minimum: 0
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        404:
          $ref: "responses/SOL005_resp.yaml#/responses/404"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        416:
          $ref: "responses/SOL005_resp.yaml#/responses/416"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
rameshnaraya's avatar
Merge Request issue.  
rameshnaraya committed
1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"

###############################################################################
# Notification endpoint                                                       #
# "/notification_endpoint" is the                                             #
# is the dummy URI used for testing, in real case endpoint URI has to         #
# provided by client.                                                         #
###############################################################################
  '/notification_endpoint':
    #SOL005 location: 8.2-1
    post:
      summary: >
        Notify about VNF package on boarding or change.
      description: >
        The POST method delivers a notification from the server to the client.
        This method shall follow the provisions specified in the 
        Tables 9.4.10.3.1-1 and 9.4.10.3.1-2 for URI query parameters,
        request and response data structures, and response codes.
        
      # Don't know how to pass multiple body parameters in the POST request. 
      # Jenkin build is failing if enable more than one body parameters, So commented body parameters.
      parameters:
        - name: VnfPackageOnboardingNotification
          description: >
            Notification about performance information availability. 
          in: body
          required: true
          schema:
            properties:
              VnfPackageOnboardingNotification:
                $ref: "definitions/SOL005VNFPMManagement_def.yaml#/definitions/VnfPackageOnboardingNotification"                
        #- name: VnfPackageChangeNotification
        #  description: >
        #    Notification about threshold crossing.
        #  in: body
        #  required: true
        #  schema:
        #    properties:
        #      VnfPackageChangeNotification:
        #        $ref: "definitions/SOL005VNFPMManagement_def.yaml#/definitions/VnfPackageChangeNotification"                
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
      responses:
        204:
          description: >
            204 - No Content.
            
            The notification was delivered successfully.         
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"                        
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        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.
        This method shall follow the provisions specified in the Tables 9.4.10.3.2-1 and 9.4.10.3.2-2 for URI query parameters,
        request and response data structures, and response codes.
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
      responses:
        204:
          description: >
            The notification endpoint was tested successfully.
            The response body shall be empty. 
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"                        
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
rameshnaraya's avatar
SOL005 2.4.1 - Fixed reference issues in spec files, generated while building Jenkins script.  
rameshnaraya committed
1263 1264 
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"
Show full blame