diff --git a/src/SOL002/VNFPerformanceManagement/VNFPerformanceManagement.yaml b/src/SOL002/VNFPerformanceManagement/VNFPerformanceManagement.yaml index 0e182f69f487246d7efa36abeb7bb378c74e9bac..398674d3f9d5f7fb1fed4a4dbe0626fc11754980 100644 --- a/src/SOL002/VNFPerformanceManagement/VNFPerformanceManagement.yaml +++ b/src/SOL002/VNFPerformanceManagement/VNFPerformanceManagement.yaml @@ -6,14 +6,11 @@ info: description: > VNF Configuration interface of ETSI NFV SOL002 - IMPORTANT: Please note that this file might be not aligned to the current version of the ETSI Group Specification it refers to. In case of discrepancies the published ETSI Group Specification takes precedence. - Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis&list_id=61&product=NFV&resolution=--- - license: name: "ETSI Forge copyright notice" url: https://forge.etsi.org/etsi-forge-copyright-notice.txt @@ -34,7 +31,6 @@ consumes: produces: - application/json - paths: ############################################################################### # API Versions # @@ -42,9 +38,9 @@ paths: '/api-versions': $ref: '../../endpoints/SOL002SOL003_endpoints.yaml#/endpoints/api-versions' -############################################################################### -# PM jobs # -############################################################################### + ############################################################################### + # PM jobs # + ############################################################################### '/pm_jobs': #SOL003 location: 6.4.2 parameters: @@ -54,6 +50,13 @@ paths: 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 post: description: > The POST method creates a PM job. @@ -78,17 +81,10 @@ paths: in: header required: true type: string - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: true - type: string responses: 201: description: > - Created + 201 CREATED The PM job was created successfully. The response body shall contain a representation of the created PM job resource. @@ -125,14 +121,24 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" 403: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + 404: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" 406: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + 416: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" + 422: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + 429: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" 500: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + 504: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" get: description: > The client can use this method to retrieve information about PM jobs. @@ -144,13 +150,6 @@ paths: in: header required: true type: string - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: true - type: string - name: Content-Type description: > The MIME type of the body of the request. @@ -233,7 +232,7 @@ paths: responses: 200: description: > - OK + 200 OK Information about zero or more PM jobs was queried successfully. The response body shall contain in an array the representations of zero or more PM jobs, @@ -275,17 +274,28 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" 403: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + 404: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" 406: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + 416: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" + 422: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + 429: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" 500: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# Individual PM job # -############################################################################### + 504: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + + ############################################################################### + # Individual PM job # + ############################################################################### '/pm_jobs/{pmJobId}': #SOL003 location: 6.4.3 parameters: @@ -305,6 +315,13 @@ paths: 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 get: description: > The client can use this method for reading an individual PM job. @@ -316,17 +333,10 @@ paths: in: header required: true type: string - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: true - type: string responses: 200: description: > - OK + 200 OK Information about an individual PM job was queried successfully. The response body shall contain a representation of the PM job @@ -358,29 +368,31 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" 403: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + 404: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" 406: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + 416: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" + 422: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + 429: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" 500: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + 504: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" delete: description: > This method terminates an individual PM job. - parameters: - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: true - type: string responses: 204: description: > - No Content + 204 NO CONTENT The PM job was deleted successfully. The response body shall be empty. @@ -409,17 +421,28 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" 403: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + 404: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" 406: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + 416: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" + 422: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + 429: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" 500: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# Individual performance report # -############################################################################### + 504: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + + ############################################################################### + # Individual performance report # + ############################################################################### '/pm_jobs/{pmJobId}/reports/{reportId}': #SOL003 location: 6.4.4 parameters: @@ -441,6 +464,13 @@ paths: 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 get: description: > The client can use this method for reading an individual performance @@ -453,17 +483,10 @@ paths: in: header required: true type: string - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: true - type: string responses: 200: description: > - OK + 200 OK Information of an individual performance report was read successfully. @@ -496,17 +519,28 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" 403: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + 404: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" 406: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + 416: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" + 422: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + 429: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" 500: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# Thresholds # -############################################################################### + 504: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + + ############################################################################### + # Thresholds # + ############################################################################### '/thresholds': #SOL003 location: 6.4.5 parameters: @@ -516,6 +550,13 @@ paths: 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 post: description: > The POST method can be used by the client to create a threshold. @@ -534,13 +575,6 @@ paths: in: header required: true type: string - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: true - type: string - name: Content-Type description: > The MIME type of the body of the request. @@ -551,7 +585,7 @@ paths: responses: 201: description: > - Created + 201 CREATED A threshold was created successfully. The response body shall contain a representation of the created threshold resource. @@ -588,14 +622,24 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" 403: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + 404: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" 406: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + 416: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" + 422: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + 429: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" 500: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + 504: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" get: description: > The client can use this method to query information about thresholds. @@ -607,13 +651,6 @@ paths: in: header required: true type: string - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: true - type: string - name: filter description: > Attribute-based filtering expression according to clause 4.3.2. @@ -657,7 +694,7 @@ paths: responses: 200: description: > - OK + 200 OK Information about zero or more thresholds was queried successfully. @@ -700,17 +737,28 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" 403: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + 404: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" 406: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + 416: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" + 422: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + 429: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" 500: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# Individual threshold # -############################################################################### + 504: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + + ############################################################################### + # Individual threshold # + ############################################################################### '/thresholds/{thresholdId}': #SOL003 location: 6.4.6 parameters: @@ -730,6 +778,13 @@ paths: 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 get: description: > The client can use this method for reading an individual threshold. @@ -741,17 +796,10 @@ paths: in: header required: true type: string - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: true - type: string responses: 200: description: > - OK + 200 OK Information about an individual threshold was queried successfully. The response body shall contain a @@ -783,14 +831,24 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" 403: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + 404: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" 406: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + 416: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" + 422: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + 429: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" 500: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + 504: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" delete: description: > This method allows to delete a threshold. @@ -802,17 +860,10 @@ paths: in: header required: true type: string - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: true - type: string responses: 204: description: > - No Content + 204 NO CONTENT The threshold was deleted successfully. The response body shall be empty. @@ -836,17 +887,28 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" 403: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + 404: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" 406: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + 416: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" + 422: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + 429: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" 500: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# Subscriptions # -############################################################################### + 504: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + + ############################################################################### + # Subscriptions # + ############################################################################### '/subscriptions': #SOL003 location: 6.4.7 parameters: @@ -856,6 +918,13 @@ paths: 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 post: description: > The POST method creates a new subscription. @@ -874,13 +943,6 @@ paths: in: header required: true type: string - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: true - type: string - name: Content-Type description: > The MIME type of the body of the request. @@ -891,7 +953,7 @@ paths: responses: 201: description: > - Created + 201 CREATED The subscription was created successfully. A representation of the created subscription resource shall be returned in the response @@ -923,20 +985,40 @@ paths: minimum: 0 schema: $ref: "../../definitions/SOL002SOL003VNFPerformanceManagement_def.yaml#/definitions/PmSubscription" + 303: + description: > + 303 SEE OTHER + + A subscription with the same callbackURI and the same filter already exists and the policy of the VNFM + is to not create redundant subscriptions. + The HTTP response shall include a "Location" HTTP header that contains the resource URI of the existing + subscription resource. + The response body shall be empty. + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/303" 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" 401: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" 403: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + 404: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" 406: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + 416: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" + 422: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + 429: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" 500: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + 504: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" get: description: > The client can use this method to query the list of active @@ -950,13 +1032,6 @@ paths: in: header required: true type: string - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: true - type: string - name: filter description: > Attribute-based filtering expression according to clause 4.3.2. @@ -1000,7 +1075,7 @@ paths: responses: 200: description: > - OK + 200 OK The list of subscriptions was queried successfully. The response body shall contain in an array the representations @@ -1043,17 +1118,28 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" 403: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + 404: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" 406: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + 416: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" + 422: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + 429: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" 500: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" -############################################################################### -# Individual subscription # -############################################################################### + 504: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" + + ############################################################################### + # Individual subscription # + ############################################################################### '/subscriptions/{subscriptionId}': #SOL003 location: 6.4.8 parameters: @@ -1072,6 +1158,13 @@ paths: 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 get: description: > The client can use this method for reading an individual subscription @@ -1084,17 +1177,10 @@ paths: in: header required: true type: string - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: true - type: string responses: 200: description: > - OK + 200 OK The subscription was read successfully. The response body shall contain a representation of the subscription resource. @@ -1125,14 +1211,24 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" 403: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + 404: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" 406: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + 416: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" + 422: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + 429: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" 500: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + 504: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" delete: description: > This method terminates an individual subscription. @@ -1144,17 +1240,10 @@ paths: in: header required: true type: string - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: true - type: string responses: 204: description: > - No Content + 204 NO CONTENT The subscription resource was deleted successfully. The response body shall be empty. @@ -1178,11 +1267,21 @@ paths: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/401" 403: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/403" + 404: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" 405: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/405" + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/404" 406: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/406" + 416: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/416" + 422: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/422" + 429: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/429" 500: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/500" 503: - $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" \ No newline at end of file + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/503" + 504: + $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/504" \ No newline at end of file