diff --git a/src/SOL002/VNFConfiguration/VNFConfiguration.yaml b/src/SOL002/VNFConfiguration/VNFConfiguration.yaml index 6f9fd7f93917792eba3d3f50a38d0a5a37b429f6..e9f9110b5fe70a56d547581614787d73aeba4f40 100644 --- a/src/SOL002/VNFConfiguration/VNFConfiguration.yaml +++ b/src/SOL002/VNFConfiguration/VNFConfiguration.yaml @@ -1,6 +1,6 @@ swagger: "2.0" info: - version: "1.1.0" + version: "1.2.0" title: "SOL002 - VNF Configuration interface" description: > SOL002 - VNF Configuration Interface @@ -36,6 +36,13 @@ paths: The GET method reads API version information. This method shall follow the provisions specified in table 4.6.3.3.3.2-1 for request and response data structures, and response codes. URI query parameters are not supported. + parameters: + - name: Version + description: > + Version of the API requested to use when responding to this request. + in: header + required: false + type: string responses: 200: description: > @@ -50,6 +57,11 @@ paths: type: string maximum: 1 minimum: 1 + Version: + description: The used API version. + type: string + maximum: 1 + minimum: 1 400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' } 401: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' } 403: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/403' } @@ -73,6 +85,13 @@ paths: summary: Read VNF/VNFC configuration from VNF description: > The client can use this method to read configuration information about a VNF instance and/or its VNFC instances. + parameters: + - name: Version + description: > + Version of the API requested to use when responding to this request. + in: header + required: false + type: string responses: 200: description: > @@ -87,6 +106,11 @@ paths: type: string maximum: 1 minimum: 1 + Version: + description: The used API version. + type: string + maximum: 1 + minimum: 1 400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' } 401: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' } 403: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/403' } @@ -114,6 +138,12 @@ paths: in: body schema: $ref: 'definitions/VnfConfiguration_def.yaml#/definitions/VnfConfigModifications' + - name: Version + description: > + Version of the API requested to use when responding to this request. + in: header + required: false + type: string responses: 200: description: > @@ -129,6 +159,11 @@ paths: type: string maximum: 1 minimum: 1 + Version: + description: The used API version. + type: string + maximum: 1 + minimum: 1 400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' } 401: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' } 403: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/403' } diff --git a/src/SOL002/VNFFaultManagement/VNFFaultManagement.yaml b/src/SOL002/VNFFaultManagement/VNFFaultManagement.yaml index 72531f8498002a5a8b3c1954349929e429f2c444..8d45bc6aaf7cd84e03ab271ede9bea3711f16d1a 100644 --- a/src/SOL002/VNFFaultManagement/VNFFaultManagement.yaml +++ b/src/SOL002/VNFFaultManagement/VNFFaultManagement.yaml @@ -1,7 +1,7 @@ swagger: "2.0" info: - version: "1.1.1" + version: "1.2.0" title: SOL002 - VNF Configuration interface description: > VNF Configuration interface of ETSI NFV SOL002 @@ -36,11 +36,69 @@ produces: paths: +############################################################################### +# API Versions # +############################################################################### + '/api-versions': + get: + summary: Retrieve API version information + description: > + The GET method reads API version information. This method shall follow the provisions specified in + table 4.6.3.3.3.2-1 for request and response data structures, and response codes. URI query parameters are not + supported. + parameters: + - name: Version + description: > + Version of the API requested to use when responding to this request. + in: header + required: false + type: string + responses: + 200: + description: > + API version information was read successfully. + The response body shall contain 4.4 API version + information, as defined in clause 4.4.1.13. + schema: + $ref: '../../definitions/SOL002SOL003_def.yaml#/definitions/ApiVersionInformation' + headers: + Content-Type: + description: The MIME type of the body of the response. + type: string + maximum: 1 + minimum: 1 + Version: + description: The used API version. + type: string + maximum: 1 + minimum: 1 + 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' } + 406: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/406' } + 413: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/413' } + 414: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/414' } + 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' } + ############################################################################### # Alarms # ############################################################################### '/alarms': #SOL003 location: 7.4.2 + parameters: + - name: Version + description: > + Version of the API requested to use when responding to this request. + in: header + required: false + type: string get: description: > The client can use this method to retrieve information about the alarm @@ -122,9 +180,12 @@ paths: inclusion of the Link HTTP header in this response shall follow the provisions in clause 4.7.2.3. headers: Content-Type: - description: > - The MIME type of the body of the request. - Reference: IETF RFC 7231 + description: The MIME type of the body of the response. + type: string + maximum: 1 + minimum: 1 + Version: + description: The used API version. type: string maximum: 1 minimum: 1 @@ -136,6 +197,7 @@ paths: type: string maximum: 1 minimum: 0 + schema: $ref: "./definitions/VNFFaultManagement_def.yaml#/definitions/Alarm" 400: @@ -169,6 +231,12 @@ paths: in: path type: string required: true + - name: Version + description: > + Version of the API requested to use when responding to this request. + in: header + required: false + type: string get: description: > The client can use this method to read an individual alarm. @@ -204,9 +272,12 @@ paths: alarm. headers: Content-Type: - description: > - The MIME type of the body of the request. - Reference: IETF RFC 7231 + description: The MIME type of the body of the response. + type: string + maximum: 1 + minimum: 1 + Version: + description: The used API version. type: string maximum: 1 minimum: 1 @@ -275,9 +346,12 @@ paths: resource. headers: Content-Type: - description: > - The MIME type of the body of the request. - Reference: IETF RFC 7231 + description: The MIME type of the body of the response. + type: string + maximum: 1 + minimum: 1 + Version: + description: The used API version. type: string maximum: 1 minimum: 1 @@ -314,6 +388,13 @@ paths: ############################################################################### '/alarms/{alarmId}/escalate': #SOL002 location: 7.4.4 + parameters: + - name: Version + description: > + Version of the API requested to use when responding to this request. + in: header + required: false + type: string post: description: > The POST method enables the consumer to escalate the perceived severity @@ -342,6 +423,12 @@ paths: The VNFM has received the proposed "escalated perceived severity" value successfully. The response body shall be empty. + headers: + Version: + description: The used API version. + type: string + maximum: 1 + minimum: 1 400: $ref: "../../responses/SOL002SOL003_resp.yaml#/responses/400" 401: @@ -364,6 +451,13 @@ paths: ############################################################################### '/subscriptions': #SOL003 location: 7.4.4 + parameters: + - name: Version + description: > + Version of the API requested to use when responding to this request. + in: header + required: false + type: string post: description: > The POST method creates a new subscription. @@ -406,9 +500,12 @@ paths: points to the created subscription resource. headers: Content-Type: - description: > - The MIME type of the body of the request. - Reference: IETF RFC 7231 + description: The MIME type of the body of the response. + type: string + maximum: 1 + minimum: 1 + Version: + description: The used API version. type: string maximum: 1 minimum: 1 @@ -522,9 +619,12 @@ paths: response shall follow the provisions in clause 4.7.2.3. headers: Content-Type: - description: > - The MIME type of the body of the request. - Reference: IETF RFC 7231 + description: The MIME type of the body of the response. + type: string + maximum: 1 + minimum: 1 + Version: + description: The used API version. type: string maximum: 1 minimum: 1 @@ -570,6 +670,12 @@ paths: in: path type: string required: true + - name: Version + description: > + Version of the API requested to use when responding to this request. + in: header + required: false + type: string get: description: > The client can use this method for reading an individual subscription @@ -606,9 +712,12 @@ paths: subscription resource. headers: Content-Type: - description: > - The MIME type of the body of the request. - Reference: IETF RFC 7231 + description: The MIME type of the body of the response. + type: string + maximum: 1 + minimum: 1 + Version: + description: The used API version. type: string maximum: 1 minimum: 1 @@ -655,10 +764,8 @@ paths: The subscription resource was deleted successfully. The response body shall be empty. headers: - Content-Type: - description: > - The MIME type of the body of the request. - Reference: IETF RFC 7231 + Version: + description: The used API version. type: string maximum: 1 minimum: 1 diff --git a/src/SOL002/VNFIndicator/VNFIndicator.yaml b/src/SOL002/VNFIndicator/VNFIndicator.yaml index 84a5ced4fe0c6f63a2b171aa137cfb98e3e63219..0860429aa13c5ae8f827ecd9e4f902f0b3075ca0 100644 --- a/src/SOL002/VNFIndicator/VNFIndicator.yaml +++ b/src/SOL002/VNFIndicator/VNFIndicator.yaml @@ -40,11 +40,69 @@ produces: paths: + ############################################################################### + # API Versions # + ############################################################################### + '/api-versions': + parameters: + - name: Version + description: > + Version of the API requested to use when responding to this request. + in: header + required: false + type: string + get: + summary: Retrieve API version information + description: > + The GET method reads API version information. This method shall follow the provisions specified in + table 4.6.3.3.3.2-1 for request and response data structures, and response codes. URI query parameters are not + supported. + responses: + 200: + description: > + API version information was read successfully. + The response body shall contain 4.4 API version + information, as defined in clause 4.4.1.13. + schema: + $ref: '../../definitions/SOL002SOL003_def.yaml#/definitions/ApiVersionInformation' + headers: + Content-Type: + description: The MIME type of the body of the response. + type: string + maximum: 1 + minimum: 1 + Version: + description: The used API version. + type: string + maximum: 1 + minimum: 1 + 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' } + 406: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/406' } + 413: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/413' } + 414: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/414' } + 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' } + ############################################################################### # VNF Indicators # ############################################################################### - /indicators: - get: + /indicators: + parameters: + - name: Version + description: > + Version of the API requested to use when responding to this request. + in: header + required: false + type: string + get: summary: Query multiple indicators description: Get a list of indicators. Support of attribute based filtering via query parameters. parameters: @@ -100,6 +158,17 @@ paths: i.e. zero or more representations of VNF indicators as defined in clause 8.5.2.2. If the EM/VNF supports alternative 2 (paging) according to clause 4.7.2.1 for this resource, inclusion of the Link HTTP header in this response shall follow the provisions in clause 4.7.2.3. + headers: + Content-Type: + description: The MIME type of the body of the response. + type: string + maximum: 1 + minimum: 1 + Version: + description: The used API version. + type: string + maximum: 1 + minimum: 1 schema: type: array items: @@ -116,8 +185,7 @@ paths: 500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' } 503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' } - - /indicators/{vnfInstanceId}: + /indicators/{vnfInstanceId}: parameters: - name: vnfInstanceId in: path @@ -130,6 +198,12 @@ paths: of that response. type: string required: true + - name: Version + description: > + Version of the API requested to use when responding to this request. + in: header + required: false + type: string get: summary: Query multiple indicators related to a VNF instance. description: > @@ -189,6 +263,17 @@ paths: If the EM/VMF supports alternative 2 (paging) according to clause 4.7.2.1 for this resource, inclusion of the Link HTTP header in this response shall follow the provisions in clause 4.7.2.3. + headers: + Content-Type: + description: The MIME type of the body of the response. + type: string + maximum: 1 + minimum: 1 + Version: + description: The used API version. + type: string + maximum: 1 + minimum: 1 schema: type: array items: @@ -206,7 +291,7 @@ paths: 503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' } - /indicators/{vnfInstanceId}/{indicatorId}: + /indicators/{vnfInstanceId}/{indicatorId}: parameters: - name: vnfInstanceId in: path @@ -226,6 +311,12 @@ paths: # LEH NOTE from SOL002 is strange type: string required: true + - name: Version + description: > + Version of the API requested to use when responding to this request. + in: header + required: false + type: string get: summary: Read an inidividual VNF indicator related to a VNF instance. description: > @@ -240,6 +331,17 @@ paths: The VNF indicator was read successfully. The response body shall contain the representation of the VNF indicator. + headers: + Content-Type: + description: The MIME type of the body of the response. + type: string + maximum: 1 + minimum: 1 + Version: + description: The used API version. + type: string + maximum: 1 + minimum: 1 schema: $ref: 'definitions/VnfIndicator_def.yaml#/definitions/VnfIndicator' 400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' } @@ -254,7 +356,7 @@ paths: 500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' } 503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' } - /indicators/{indicatorId}: + /indicators/{indicatorId}: parameters: - name: indicatorId in: path @@ -262,6 +364,12 @@ paths: Identifier of the VNF indicator. type: string required: true + - name: Version + description: > + Version of the API requested to use when responding to this request. + in: header + required: false + type: string get: summary: Read an inidividual VNF indicator related to a VNF instance. description: > @@ -273,6 +381,17 @@ paths: The VNF indicator was read successfully. The response body shall contain the representation of the VNF indicator. + headers: + Content-Type: + description: The MIME type of the body of the response. + type: string + maximum: 1 + minimum: 1 + Version: + description: The used API version. + type: string + maximum: 1 + minimum: 1 schema: $ref: 'definitions/VnfIndicator_def.yaml#/definitions/VnfIndicator' 400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' } @@ -287,8 +406,15 @@ paths: 500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' } 503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' } - /subscriptions: - post: + /subscriptions: + parameters: + - name: Version + description: > + Version of the API requested to use when responding to this request. + in: header + required: false + type: string + post: summary: Create a new subscription to VNF indicator change notifications description: Create a new subscription parameters: @@ -312,7 +438,17 @@ paths: description: > Pointer to the created subscription resource. type: string - format: URI + format: URI + Content-Type: + description: The MIME type of the body of the response. + type: string + maximum: 1 + minimum: 1 + Version: + description: The used API version. + type: string + maximum: 1 + minimum: 1 400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' } 401: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' } 403: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/403' } @@ -324,7 +460,7 @@ paths: 422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' } 500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' } 503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' } - get: + get: summary: Query multiple subscriptions. description: > Service Unavailable @@ -386,6 +522,17 @@ paths: as defined in clause 8.5.2.4. If the EM supports alternative 2 (paging) according to clause 4.7.2.1 for this resource, inclusion of the Link HTTP header in this response shall follow the provisions in clause 4.7.2.3. + headers: + Content-Type: + description: The MIME type of the body of the response. + type: string + maximum: 1 + minimum: 1 + Version: + description: The used API version. + type: string + maximum: 1 + minimum: 1 schema: type: array items: @@ -403,8 +550,15 @@ paths: 503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' } - /subscriptions/{subscriptionId}: - get: + /subscriptions/{subscriptionId}: + parameters: + - name: Version + description: > + Version of the API requested to use when responding to this request. + in: header + required: false + type: string + get: summary: Read an individual subscription. description: > Service Unavailable @@ -429,6 +583,17 @@ paths: The subscriptions was queried successfully. The response body shall contain the representation of the requested subscription. + headers: + Content-Type: + description: The MIME type of the body of the response. + type: string + maximum: 1 + minimum: 1 + Version: + description: The used API version. + type: string + maximum: 1 + minimum: 1 schema: $ref: 'definitions/VnfIndicatorSubscription_def.yaml#/definitions/VnfIndicatorSubscription' 400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' } @@ -442,7 +607,7 @@ paths: 422: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/422' } 500: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/500' } 503: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/503' } - delete: + delete: summary: Delete a subscription description: Terminate an individual subscription. parameters: @@ -465,6 +630,12 @@ paths: The subscription was deleted successfully. The response body shall be empty. + headers: + Version: + description: The used API version. + type: string + maximum: 1 + minimum: 1 400: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/400' } 401: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/401' } 403: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/403' } diff --git a/src/SOL002/VNFIndicatorNotification/VNFIndicatorNotification.yaml b/src/SOL002/VNFIndicatorNotification/VNFIndicatorNotification.yaml index 8d6814cc0a762e615ea5280a2cf6df06446b6b5c..34c984c6a8c95a0fd61561ef16eacf73ac536f1f 100644 --- a/src/SOL002/VNFIndicatorNotification/VNFIndicatorNotification.yaml +++ b/src/SOL002/VNFIndicatorNotification/VNFIndicatorNotification.yaml @@ -37,8 +37,6 @@ produces: paths: - - /notificationendpoint: post: summary: Notification endpoint diff --git a/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml b/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml index 7f0dbd4a5c05b9f251c7803398982b2c453d6ec3..6f30655a667e45eb0c60ab80708f59bd4f0e5236 100644 --- a/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml +++ b/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml @@ -36,6 +36,49 @@ produces: paths: ############################################################################### +# API Versions # +############################################################################### + '/api-versions': + get: + summary: Retrieve API version information + description: > + The GET method reads API version information. This method shall follow the provisions specified in + table 4.6.3.3.3.2-1 for request and response data structures, and response codes. URI query parameters are not + supported. + responses: + 200: + description: > + API version information was read successfully. + The response body shall contain 4.4 API version + information, as defined in clause 4.4.1.13. + schema: + $ref: '../../definitions/SOL002SOL003_def.yaml#/definitions/ApiVersionInformation' + headers: + Content-Type: + description: The MIME type of the body of the response. + type: string + maximum: 1 + minimum: 1 + Version: + description: The used API version. + type: string + maximum: 1 + minimum: 1 + 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' } + 406: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/406' } + 413: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/413' } + 414: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/414' } + 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' } +############################################################################### # VNF instances # ############################################################################### '/vnf_instances': diff --git a/src/SOL002/VNFPerformanceManagement/VNFPerformanceManagement.yaml b/src/SOL002/VNFPerformanceManagement/VNFPerformanceManagement.yaml index 0a5f191d495e02feae7772c972051f6af9c873df..859878d63cd7b4d601eb8737cb9726dad18819bf 100644 --- a/src/SOL002/VNFPerformanceManagement/VNFPerformanceManagement.yaml +++ b/src/SOL002/VNFPerformanceManagement/VNFPerformanceManagement.yaml @@ -36,11 +36,69 @@ produces: paths: +############################################################################### +# API Versions # +############################################################################### + '/api-versions': + parameters: + - name: Version + description: > + Version of the API requested to use when responding to this request. + in: header + required: false + type: string + get: + summary: Retrieve API version information + description: > + The GET method reads API version information. This method shall follow the provisions specified in + table 4.6.3.3.3.2-1 for request and response data structures, and response codes. URI query parameters are not + supported. + responses: + 200: + description: > + API version information was read successfully. + The response body shall contain 4.4 API version + information, as defined in clause 4.4.1.13. + schema: + $ref: '../../definitions/SOL002SOL003_def.yaml#/definitions/ApiVersionInformation' + headers: + Content-Type: + description: The MIME type of the body of the response. + type: string + maximum: 1 + minimum: 1 + Version: + description: The used API version. + type: string + maximum: 1 + minimum: 1 + 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' } + 406: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/406' } + 413: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/413' } + 414: { $ref: '../../responses/SOL002SOL003_resp.yaml#/responses/414' } + 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' } + ############################################################################### # PM jobs # ############################################################################### '/pm_jobs': #SOL003 location: 6.4.2 + parameters: + - name: Version + description: > + Version of the API requested to use when responding to this request. + in: header + required: false + type: string post: description: > The POST method creates a PM job. @@ -82,6 +140,16 @@ paths: The HTTP response shall include a "Location" HTTP header that points to the created PM job resource. headers: + Content-Type: + description: The MIME type of the body of the response. + type: string + maximum: 1 + minimum: 1 + Version: + description: The used API version. + type: string + maximum: 1 + minimum: 1 Location: description: The resource URI of the created PM Job type: string @@ -218,6 +286,16 @@ paths: If the VNFM supports alternative 2 (paging) according to clause 4.7.2.1 for this resource, inclusion of the Link HTTP header in this response shall follow the provisions in clause 4.7.2.3. headers: + Content-Type: + description: The MIME type of the body of the response. + type: string + maximum: 1 + minimum: 1 + Version: + description: The used API version. + type: string + maximum: 1 + minimum: 1 WWW-Authenticate: description: > Challenge if the corresponding HTTP request has not provided @@ -260,6 +338,12 @@ paths: in: path type: string required: true + - name: Version + description: > + Version of the API requested to use when responding to this request. + in: header + required: false + type: string get: description: > The client can use this method for reading an individual PM job. @@ -287,6 +371,16 @@ paths: The response body shall contain a representation of the PM job resource. headers: + Content-Type: + description: The MIME type of the body of the response. + type: string + maximum: 1 + minimum: 1 + Version: + description: The used API version. + type: string + maximum: 1 + minimum: 1 WWW-Authenticate: description: > Challenge if the corresponding HTTP request has not provided @@ -330,6 +424,16 @@ paths: The PM job was deleted successfully. The response body shall be empty. headers: + Content-Type: + description: The MIME type of the body of the response. + type: string + maximum: 1 + minimum: 1 + Version: + description: The used API version. + type: string + maximum: 1 + minimum: 1 WWW-Authenticate: description: > Challenge if the corresponding HTTP request has not provided @@ -370,6 +474,12 @@ paths: in: path type: string required: true + - name: Version + description: > + Version of the API requested to use when responding to this request. + in: header + required: false + type: string get: description: > The client can use this method for reading an individual performance @@ -399,6 +509,16 @@ paths: The response body shall contain a representation of the performance report resource. headers: + Content-Type: + description: The MIME type of the body of the response. + type: string + maximum: 1 + minimum: 1 + Version: + description: The used API version. + type: string + maximum: 1 + minimum: 1 WWW-Authenticate: description: > Challenge if the corresponding HTTP request has not provided @@ -428,6 +548,13 @@ paths: ############################################################################### '/thresholds': #SOL003 location: 6.4.5 + parameters: + - name: Version + description: > + Version of the API requested to use when responding to this request. + in: header + required: false + type: string post: description: > The POST method can be used by the client to create a threshold. @@ -470,6 +597,16 @@ paths: The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created threshold resource. headers: + Content-Type: + description: The MIME type of the body of the response. + type: string + maximum: 1 + minimum: 1 + Version: + description: The used API version. + type: string + maximum: 1 + minimum: 1 Location: description: The resource URI of the created VNF instance type: string @@ -568,6 +705,16 @@ paths: If the VNFM supports alternative 2 (paging) according to clause 4.7.2.1 for this resource, inclusion of the Link HTTP header in this response shall follow the provisions in clause 4.7.2.3. headers: + Content-Type: + description: The MIME type of the body of the response. + type: string + maximum: 1 + minimum: 1 + Version: + description: The used API version. + type: string + maximum: 1 + minimum: 1 Location: description: The resource URI of the created VNF instance type: string @@ -614,6 +761,12 @@ paths: in: path type: string required: true + - name: Version + description: > + Version of the API requested to use when responding to this request. + in: header + required: false + type: string get: description: > The client can use this method for reading an individual threshold. @@ -641,6 +794,16 @@ paths: successfully. The response body shall contain a representation of the threshold. headers: + Content-Type: + description: The MIME type of the body of the response. + type: string + maximum: 1 + minimum: 1 + Version: + description: The used API version. + type: string + maximum: 1 + minimum: 1 WWW-Authenticate: description: > Challenge if the corresponding HTTP request has not provided @@ -691,6 +854,11 @@ paths: The threshold was deleted successfully. The response body shall be empty. headers: + Version: + description: The used API version. + type: string + maximum: 1 + minimum: 1 WWW-Authenticate: description: > Challenge if the corresponding HTTP request has not provided @@ -718,6 +886,13 @@ paths: ############################################################################### '/subscriptions': #SOL003 location: 6.4.7 + parameters: + - name: Version + description: > + Version of the API requested to use when responding to this request. + in: header + required: false + type: string post: description: > The POST method creates a new subscription. @@ -761,6 +936,16 @@ paths: The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created subscription resource. headers: + Content-Type: + description: The MIME type of the body of the response. + type: string + maximum: 1 + minimum: 1 + Version: + description: The used API version. + type: string + maximum: 1 + minimum: 1 Location: description: The resource URI of the created VNF instance type: string @@ -862,9 +1047,12 @@ paths: inclusion of the Link HTTP header in this response shall follow the provisions in clause 4.7.2.3. headers: Content-Type: - description: > - The MIME type of the body of the request. - Reference: IETF RFC 7231 + description: The MIME type of the body of the response. + type: string + maximum: 1 + minimum: 1 + Version: + description: The used API version. type: string maximum: 1 minimum: 1 @@ -909,6 +1097,12 @@ paths: in: path type: string required: true + - name: Version + description: > + Version of the API requested to use when responding to this request. + in: header + required: false + type: string get: description: > The client can use this method for reading an individual subscription @@ -937,9 +1131,12 @@ paths: contain a representation of the subscription resource. headers: Content-Type: - description: > - The MIME type of the body of the request. - Reference: IETF RFC 7231 + description: The MIME type of the body of the response. + type: string + maximum: 1 + minimum: 1 + Version: + description: The used API version. type: string maximum: 1 minimum: 1 @@ -993,6 +1190,11 @@ paths: The subscription resource was deleted successfully. The response body shall be empty. headers: + Version: + description: The used API version. + type: string + maximum: 1 + minimum: 1 WWW-Authenticate: description: > Challenge if the corresponding HTTP request has not provided