From efa77b60a8cc3c0b1520b953c2e28b5531479062 Mon Sep 17 00:00:00 2001 From: moscatelli Date: Mon, 15 Jul 2019 11:46:26 +0200 Subject: [PATCH] SOL005: NSD Management and NS Lifecycle Management overall consolidation --- src/SOL005/NSDManagement/NSDManagement.yaml | 405 ++++++++++-------- .../NSLifecycleManagement.yaml | 391 +++++++++++++++-- .../NSLifecycleManagementNotification.yaml | 24 -- src/SOL005/definitions/SOL005_def.yaml | 19 + src/SOL005/responses/SOL005_resp.yaml | 45 +- 5 files changed, 625 insertions(+), 259 deletions(-) diff --git a/src/SOL005/NSDManagement/NSDManagement.yaml b/src/SOL005/NSDManagement/NSDManagement.yaml index 6db0adb..a01994f 100644 --- a/src/SOL005/NSDManagement/NSDManagement.yaml +++ b/src/SOL005/NSDManagement/NSDManagement.yaml @@ -62,7 +62,7 @@ paths: post: summary: Create a new NS descriptor resource. description: > - The POST method is used to create a new NS descriptor resource or a new version of an on-boarded NS descriptor. + The POST method is used to create a new NS descriptor resource. parameters: - name: Accept description: > @@ -90,11 +90,14 @@ paths: description: > 201 CREATED - An NS descriptor resource has been created successfully, as a new NS descriptor resource. - The response body shall contain a representation of the new NS descriptor resource, - as defined in clause 5.5.2.2. - The HTTP response shall include a "Location" HTTP header that contains the resource URI - of the new NS descriptor resource. + An NS descriptor resource has been created + successfully, as a new NS descriptor resource. + The response body shall contain a representation + of the new NS descriptor resource, as defined in + clause 5.5.2.2. + The HTTP response shall include a "Location" + HTTP header that contains the resource URI of the + new NS descriptor resource. schema: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo" headers: @@ -134,14 +137,13 @@ paths: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: $ref: "../responses/SOL005_resp.yaml#/responses/503" + 504: + $ref: "../responses/SOL005_resp.yaml#/responses/504" get: summary: Query information about multiple NS descriptor resources. description: > The GET method queries information about multiple NS descriptor resources. - This method shall follow the provisions specified in the - Tables 5.4.2.3.2-1 and 5.4.2.3.2-2 for URI query parameters, - request and response data structures, and response codes. parameters: - name: filter in: query @@ -206,10 +208,14 @@ paths: 200 OK Information about zero or more NS descriptors. - The response body shall contain in an array the representations of zero or more NS descriptors, - as defined in clause 5.5.2.2. - If the NFVO 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. + The response body shall contain in an array the + representations of zero or more NS descriptors, as + defined in clause 5.5.2.2. + If the NFVO supports alternative 2 (paging) according + to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for + this resource, inclusion of the Link HTTP header in + this response shall follow the provisions in clause + 5.4.2.3 of ETSI GS NFV-SOL 013. headers: Content-Type: description: The MIME type of the body of the response. @@ -256,6 +262,8 @@ paths: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: $ref: "../responses/SOL005_resp.yaml#/responses/503" + 504: + $ref: "../responses/SOL005_resp.yaml#/responses/504" ############################################################################### # Individual NS Descriptor # @@ -287,9 +295,6 @@ paths: summary: Read information about an individual NS descriptor resource. description: > The GET method reads information about an individual NS descriptor. - This method shall follow the provisions specified in GS NFV-SOL 005 Tables - 5.4.3.3.2-1 and 5.4.3.3.2-2 of GS NFV-SOL 005 for URI query parameters, - request and response data structures, and response codes. parameters: - name: Accept description: > @@ -304,8 +309,9 @@ paths: 200 OK Information about the individual NS descriptor. - The response body shall contain a representation of the individual NS descriptor, - as defined in clause 5.5.2.2. + The response body shall contain a representation of + the individual NS descriptor, as defined in + clause 5.5.2.2. schema: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo" headers: @@ -344,18 +350,20 @@ paths: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: $ref: "../responses/SOL005_resp.yaml#/responses/503" + 504: + $ref: "../responses/SOL005_resp.yaml#/responses/504" patch: summary: Modify the operational state and/or the user defined data of an individual NS descriptor resource. description: > - The PATCH method modifies the operational state and/or user defined - data of an individual NS descriptor resource. This method can be used to: - 1) Enable a previously disabled individual NS descriptor resource, allowing - again its use for instantiation of new network service with this descriptor. - The usage state (i.e. "IN_USE/NOT_IN_USE") shall not change as result. - 2) Disable a previously enabled individual NS descriptor resource, preventing - any further use for instantiation of new network service(s) with this descriptor. - The usage state (i.e. "IN_USE/NOT_IN_USE") shall not changes a result. + The PATCH method modifies the operational state and/or user defined data of an individual NS descriptor resource. + This method can be used to: + 1) Enable a previously disabled individual NS descriptor resource, allowing again its use for instantiation of new + network service with this descriptor. The usage state (i.e. "IN_USE/NOT_IN_USE") shall not change as a + result. + 2) Disable a previously enabled individual NS descriptor resource, preventing any further use for instantiation of + new network service(s) with this descriptor. The usage state (i.e. "IN_USE/NOT_IN_USE") shall not change + as a result. 3) Modify the user defined data of an individual NS descriptor resource. parameters: - name: NsdInfoModifications @@ -418,10 +426,15 @@ paths: description: > 409 CONFLICT - Error: The operation cannot be executed currently, due to a conflict with the state of the resource. - Typically, this is due to an operational state mismatch, i.e. enable an already enabled or disable - an already disabled individual NS descriptor resource, or the "nsdOnboardingState" is not ONBOARDED. - The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall convey + Error: The operation cannot be executed currently, + due to a conflict with the state of the resource. + Typically, this is due to an operational state + mismatch, i.e. enable an already enabled or + disable an already disabled individual NS + descriptor resource, or the "nsdOnboardingState" + is not ONBOARDED. + The response body shall contain a ProblemDetails + structure, in which the "detail" attribute shall convey more information about the error. $ref: "../responses/SOL005_resp.yaml#/responses/409" 412: @@ -430,6 +443,8 @@ paths: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: $ref: "../responses/SOL005_resp.yaml#/responses/503" + 504: + $ref: "../responses/SOL005_resp.yaml#/responses/504" delete: summary: Delete an individual NS descriptor resource. @@ -490,17 +505,23 @@ paths: description: > 409 CONFLICT - Error: The operation cannot be executed currently, due to a conflict with the state of the resource. - Typically, this is due to the fact the NS descriptor resource is in the enabled operational state - (i.e. operationalState = ENABLED) or there are running NS instances using the concerned individual - NS descriptor resource (i.e. usageState = IN_USE). - The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall - convey more information about the error. + Error: The operation cannot be executed currently, + due to a conflict with the state of the resource. + Typically, this is due to the fact the NS descriptor + resource is in the enabled operational state (i.e. + operationalState = ENABLED) or there are running + NS instances using the concerned individual NS + descriptor resource (i.e. usageState = IN_USE). + The response body shall contain a ProblemDetails + structure, in which the "detail" attribute shall convey + more information about the error. $ref: "../responses/SOL005_resp.yaml#/responses/409" 500: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: $ref: "../responses/SOL005_resp.yaml#/responses/503" + 504: + $ref: "../responses/SOL005_resp.yaml#/responses/504" ############################################################################### # NSD Content # @@ -530,20 +551,16 @@ paths: summary: Fetch the content of a NSD. description: > The GET method fetches the content of the NSD. - The NSD can be implemented as a single file or as a collection of multiple files. - If the NSD is implemented in the form of multiple files, a ZIP file embedding - these files shall be returned. If the NSD is implemented as a single file, - either that file or a ZIP file embedding that file shall be returned. - The selection of the format is controlled by the "Accept" HTTP header passed - in the GET request:• If the "Accept" header contains only "text/plain" - and the NSD is implemented as a single file, the file shall be returned; - otherwise, an error message shall be returned.• If the "Accept" header - contains only "application/zip", the single file or the multiple files - that make up the NSD shall be returned embedded in a ZIP file.• If the - "Accept" header contains both "text/plain" and "application/zip", - it is up to the NFVO to choose the format to return for a single-file NSD; - for a multi-file NSD, a ZIP file shall be returned.NOTE: The structure - of the NSD zip file is outside the scope of the present document. + The NSD can be implemented as a single file or as a collection of multiple files. If the NSD is implemented in the form + of multiple files, a ZIP file embedding these files shall be returned. If the NSD is implemented as a single file, either + that file or a ZIP file embedding that file shall be returned. + The selection of the format is controlled by the "Accept" HTTP header passed in the GET request: + • If the "Accept" header contains only "text/plain" and the NSD is implemented as a single file, the file shall be + returned; otherwise, an error message shall be returned. + • If the "Accept" header contains only "application/zip", the single file or the multiple files that make up the + NSD shall be returned embedded in a ZIP file. + • If the "Accept" header contains both "text/plain" and "application/zip", it is up to the NFVO to choose the + format to return for a single-file NSD; for a multi-file NSD, a ZIP file shall be returned. parameters: - name: Accept description: > @@ -570,15 +587,16 @@ paths: description: > 200 OK - Shall be returned when the content of the NSD has been read successfully. + Shall be returned when the content of the NSD has + been read successfully. The payload body shall contain a copy of the file - representing the NSD or a ZIP file that contains the file - or multiple files representing the NSD, as specified - above. + representing the NSD or a ZIP file that contains the + file or multiple files representing the NSD, as + specified above. The "Content-Type" HTTP header shall be set according to the format of the returned file, i.e. to - "text/plain" for a YAML file or to "application/zip" for a - ZIP file. + "text/plain" for a YAML file or to "application/zip" for + a ZIP file. headers: Content-Type: description: The MIME type of the body of the response. @@ -603,11 +621,15 @@ paths: description: > 206 PARTIAL CONTENT - On success, if the NFVO supports range requests, a single consecutive byte range from the content - of the NSD file is returned. - The response body shall contain the requested part of the NSD file. - The "Content-Range" HTTP header shall be provided according to IETF RFC 7233. - The "Content-Type" HTTP header shall be set as defined above for the "200 OK" response. + On success, if the NFVO supports range requests, + a single consecutive byte range from the content of + the NSD file is returned. + The response body shall contain the requested part + of the NSD file. + The "Content-Range" HTTP header shall be + provided according to IETF RFC 7233. + The "Content-Type" HTTP header shall be set as + defined above for the "200 OK" response. $ref: "../responses/SOL005_resp.yaml#/responses/206" 400: $ref: "../responses/SOL005_resp.yaml#/responses/400" @@ -620,49 +642,61 @@ paths: 405: $ref: "../responses/SOL005_resp.yaml#/responses/405" 406: + description: > + 406 NOT ACCEPTABLE + + If the "Accept" header does not contain at least one + name of a content type for which the NFVO can + provide a representation of the NSD, the NFVO + shall respond with this response code. + The "ProblemDetails" structure may be included + with the "detail" attribute providing more information + about the error. $ref: "../responses/SOL005_resp.yaml#/responses/406" 409: description: > 409 CONFLICT - Shall be returned upon the following error: - The operation cannot be executed currently, due to a conflict with the state of the resource. - Typically, this is due to the fact "nsdOnboardingState" has a value different from ONBOARDED. - The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall - convey more information about the error. + Shall be returned upon the following error: The + operation cannot be executed currently, due to a + conflict with the state of the resource. + Typically, this is due to the fact + "nsdOnboardingState" has a value different from + ONBOARDED. + The response body shall contain a ProblemDetails + structure, in which the "detail" attribute shall convey + more information about the error. $ref: "../responses/SOL005_resp.yaml#/responses/409" 416: description: > 416 RANGE NOT SATISFIABLE - The byte range passed in the "Range" header did not match any available byte range in the NSD file + The byte range passed in the "Range" header did + not match any available byte range in the NSD file (e.g. "access after end of file"). - The response body may contain a ProblemDetails structure. + The response body may contain a ProblemDetails + structure. $ref: "../responses/SOL005_resp.yaml#/responses/416" 500: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: $ref: "../responses/SOL005_resp.yaml#/responses/503" + 504: + $ref: "../responses/SOL005_resp.yaml#/responses/504" put: summary: Upload the content of a NSD. description: > - "The PUT method is used to upload the content of a NSD. The NSD - to be uploaded can be implemented as a single file or as a collection of - multiple files, as defined in clause 5.4.4.3.2 of GS NFV-SOL 005. - If the NSD is implemented in the form of multiple files, a ZIP file embedding these - files shall be uploaded. - If the NSD is implemented as a single file, either that file or a ZIP file - embedding that file shall be uploaded. The "Content-Type" - HTTP header in the PUT request shall be set accordingly based on the format - selection of the NSD. - If the NSD to be uploaded is a text file, the "Content-Type" - header is set to "text/plain". - If the NSD to be uploaded is a zip file, - the "Content-Type" header is set to "application/zip". - This method shall follow the provisions specified in the Tables 5.4.4.3.3-1 and 5.4.4.3.3-2 - of GS-NFV-SOL 005 for URI query parameters, request and response data structures, - and response codes." + The PUT method is used to upload the content of a NSD. + The NSD to be uploaded can be implemented as a single file or as a collection of multiple files, as defined in + clause 5.4.4.3.2. If the NSD is implemented in the form of multiple files, a ZIP file embedding these files shall be + uploaded. If the NSD is implemented as a single file, either that file or a ZIP file embedding that file shall be uploaded. + ETSI + 47 ETSI GS NFV-SOL 005 V2.6.1 (2019-04) + The "Content-Type" HTTP header in the PUT request shall be set accordingly based on the format selection of the + NSD: + • If the NSD to be uploaded is a text file, the "Content-Type" header is set to "text/plain". + • If the NSD to be uploaded is a zip file, the "Content-Type" header is set to "application/zip". parameters: - name: Accept description: > @@ -680,13 +714,16 @@ paths: description: > 202 ACCEPTED - The NSD content has been accepted for uploading, but the processing has not been completed. - It is expected to take some time for processing (asynchronous mode). + The NSD content has been accepted for uploading, + but the processing has not been completed. It is + expected to take some time for processing + (asynchronous mode). The response body shall be empty. - - The client can track the uploading progress by receiving the "NsdOnBoardingNotification" and - "NsdOnBoardingFailureNotification" from the NFVO or by reading the status of the individual - NS descriptor resource using the GET method. + The client can track the uploading progress by + receiving the "NsdOnBoardingNotification" and + "NsdOnBoardingFailureNotification" from the NFVO + or by reading the status of the individual NS descriptor + resource using the GET method. headers: Content-Type: description: The MIME type of the body of the response. @@ -711,7 +748,8 @@ paths: description: > 204 NO CONTENT - The NSD content successfully uploaded and validated (synchronous mode). + The NSD content successfully uploaded and + validated (synchronous mode). The response body shall be empty. headers: WWW-Authenticate: @@ -744,15 +782,21 @@ paths: description: > 409 CONFLICT - Error: The operation cannot be executed currently, due to a conflict with the state of the resource. - Typically, this is due to the fact that the NsdOnboardingState has a value other than CREATED. - The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall - convey more information about the error. + Error: The operation cannot be executed currently, + due to a conflict with the state of the resource. + Typically, this is due to the fact that the + NsdOnboardingState has a value other than + CREATED. + The response body shall contain a ProblemDetails + structure, in which the "detail" attribute shall convey + more information about the error. $ref: "../responses/SOL005_resp.yaml#/responses/409" 500: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: $ref: "../responses/SOL005_resp.yaml#/responses/503" + 504: + $ref: "../responses/SOL005_resp.yaml#/responses/504" ############################################################################### # PNF Descriptors # @@ -805,13 +849,14 @@ paths: description: > 201 CREATED - A PNF descriptor resource has been created successfully, as a new PNF descriptor resource. + A PNF descriptor resource has been created + successfully, as a new PNF descriptor resource. The response body shall contain a representation of the new PNF descriptor resource, as defined in clause 5.5.2.5. - The HTTP response shall include a "Location" HTTP - header that contains the resource URI of the new - PNF descriptor resource. + The HTTP response shall include a "Location" + HTTP header that contains the resource URI of the + new PNF descriptor resource. schema: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfo" headers: @@ -851,6 +896,8 @@ paths: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: $ref: "../responses/SOL005_resp.yaml#/responses/503" + 504: + $ref: "../responses/SOL005_resp.yaml#/responses/504" get: summary: Query information about multiple PNF descriptor resources. @@ -914,13 +961,14 @@ paths: 200 OK Information about zero or more PNF descriptors. - The response body shall contain a representation of - zero or more PNF descriptors, as defined in - clause 5.5.2.5 - - If the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 - for this resource, inclusion of the Link HTTP header in this response shall follow the provisions - in clause 5.4.2.3 of ETSI GS NFV-SOL 013. + The response body shall contain in an array the + representations of zero or more PNF descriptors, as + defined in clause 5.5.2.5. + If the NFVO supports alternative 2 (paging) according + to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for + this resource, inclusion of the Link HTTP header in + this response shall follow the provisions in clause + 5.4.2.3 of ETSI GS NFV-SOL 013. headers: Content-Type: description: The MIME type of the body of the response. @@ -973,6 +1021,8 @@ paths: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: $ref: "../responses/SOL005_resp.yaml#/responses/503" + 504: + $ref: "../responses/SOL005_resp.yaml#/responses/504" ############################################################################### # Individual PNF Descriptor # @@ -991,9 +1041,6 @@ paths: summary: Read an individual PNFD resource. description: > The GET method reads information about an individual PNF descriptor. - This method shall follow the provisions specified in the Tables 5.4.6.3.2-1 - and 5.4.6.3.2-2 of GS NFV-SOL 005 for URI query parameters, request and - response data structures, and response codes. parameters: - name: Accept in: header @@ -1023,7 +1070,8 @@ paths: Information about the individual PNFD descriptor. The response body shall contain a representation of - the individual PNF descriptor. + the individual PNF descriptor, as defined in + clause 5.5.2.5. headers: Content-Type: description: The MIME type of the body of the response. @@ -1062,6 +1110,8 @@ paths: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: $ref: "../responses/SOL005_resp.yaml#/responses/503" + 504: + $ref: "../responses/SOL005_resp.yaml#/responses/504" patch: summary: Modify the user defined data of an individual PNF descriptor resource. @@ -1096,7 +1146,8 @@ paths: 200 OK The operation has been completed successfully. - The response body shall contain attribute modifications for an 'Individual PNF Descriptor' + The response body shall contain attribute + modifications for an 'Individual PNF Descriptor' resource (see clause 5.5.2.4). schema: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfoModifications" @@ -1139,6 +1190,8 @@ paths: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: $ref: "../responses/SOL005_resp.yaml#/responses/503" + 504: + $ref: "../responses/SOL005_resp.yaml#/responses/504" delete: summary: Delete an individual PNF descriptor resource. @@ -1146,10 +1199,9 @@ paths: The DELETE method deletes an individual PNF descriptor resource. An individual PNF descriptor resource can only be deleted when there is no NS instance using it or there is NSD referencing it. - To delete all PNFD versions identified by a particular value of the "pnfdInvariantId" attribute, the procedure - is to first use the GET method with filter "pnfdInvariantId" towards the PNF descriptors resource to find - all versions of the PNFD. - Then, the client uses the DELETE method described in this clause to delete each PNFD version individually. + To delete all PNFD versions identified by a particular value of the "pnfdInvariantId" attribute, the procedure is to first + use the GET method with filter "pnfdInvariantId" towards the PNF descriptors resource to find all versions of the + PNFD. Then, the client uses the DELETE method described in this clause to delete each PNFD version individually. responses: 204: description: > @@ -1188,6 +1240,8 @@ paths: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: $ref: "../responses/SOL005_resp.yaml#/responses/503" + 504: + $ref: "../responses/SOL005_resp.yaml#/responses/504" ############################################################################### # PNFD Content # @@ -1236,9 +1290,12 @@ paths: description: > 200 OK - Shall be returned when the content of the PNFD has been read successfully. - The payload body shall contain a copy of the file representing the PNFD. - The "Content-Type" HTTP header shall be set to "text/plain". + Shall be returned when the content of the PNFD has + been read successfully. + The payload body shall contain a copy of the file + representing the PNFD. + The "Content-Type" HTTP header shall be set to + "text/plain". headers: Content-Type: description: The MIME type of the body of the response. @@ -1275,16 +1332,21 @@ paths: description: > 409 CONFLICT - Shall be returned upon the following error: The operation cannot be executed currently, - due to a conflict with the state of the resource. - Typically, this is due to the fact pnfdOnboardingState has a value different from ONBOARDED. - The response body shall contain a ProblemDetails structure, in which the "detail" attribute - shall convey more information about the error. + Shall be returned upon the following error: The + operation cannot be executed currently, due to a + conflict with the state of the resource. + Typically, this is due to the fact pnfdOnboardingState + has a value different from ONBOARDED. + The response body shall contain a ProblemDetails + structure, in which the "detail" attribute shall convey + more information about the error. $ref: "../responses/SOL005_resp.yaml#/responses/409" 500: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: $ref: "../responses/SOL005_resp.yaml#/responses/503" + 504: + $ref: "../responses/SOL005_resp.yaml#/responses/504" put: summary: Upload the content of a PNFD. @@ -1339,10 +1401,14 @@ paths: description: > 409 CONFLICT - Error: The operation cannot be executed currently, due to a conflict with the state of the resource. - Typically, this is due to the fact that the PnfdOnboardingState has a value other than CREATED. - The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall - convey more information about the error. + Error: The operation cannot be executed currently, + due to a conflict with the state of the resource. + Typically, this is due to the fact that the + PnfdOnboardingState has a value other than + CREATED. + The response body shall contain a ProblemDetails + structure, in which the "detail" attribute shall convey + more information about the error. $ref: "../responses/SOL005_resp.yaml#/responses/409" 500: $ref: "../responses/SOL005_resp.yaml#/responses/500" @@ -1373,22 +1439,14 @@ paths: summary: Subscribe to NSD and PNFD change notifications. description: > The POST method creates a new subscription. - This method shall support the URI query parameters, request and response data structures, - and response codes, as specified in the Tables 5.4.8.3.1-1 and 5.4.8.3.1-2 - of GS-NFV SOL 005. Creation of two subscription resources with the same - callbackURI and the same filter can result in performance degradation and - will provide duplicates of notifications to the OSS, and might make sense - only in very rare use cases. Consequently, the NFVO may either allow creating - a subscription resource if another subscription resource with the same filter - and callbackUri already exists (in which case it shall return the "201 - Created" response code), or may decide to not create a duplicate subscription - resource (in which case it shall return a "303 See Other" response code - referencing the existing subscription resource with the same filter and - callbackUri). - - This resource represents subscriptions. - The client can use this resource to subscribe to notifications related to NSD - management and to query its subscriptions. + This method shall support the URI query parameters, request and response data structures, and response codes, as + specified in the Tables 5.4.8.3.1-1 and 5.4.8.3.1-2. + Creation of two subscription resources with the same callbackURI and the same filter can result in performance + degradation and will provide duplicates of notifications to the OSS, and might make sense only in very rare use cases. + Consequently, the NFVO may either allow creating a subscription resource if another subscription resource with the + same filter and callbackUri already exists (in which case it shall return the "201 Created" response code), or may decide + to not create a duplicate subscription resource (in which case it shall return a "303 See Other" response code referencing + the existing subscription resource with the same filter and callbackUri). parameters: - name: Accept description: > @@ -1416,10 +1474,13 @@ paths: description: > 201 CREATED - Shall be returned when the subscription has been created successfully.. - The response body shall contain a representation of the created subscription resource. + Shall be returned when the subscription has been + created successfully. + The response body shall contain a representation + of the created subscription resource. The HTTP response shall include a "Location:" - HTTP header that points to the created subscription resource. + HTTP header that points to the created + subscription resource. schema: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscription" headers: @@ -1447,10 +1508,13 @@ paths: description: > 303 SEE OTHER - Shall be returned when a subscription with the same callbackURI and the same filter already - exits and the policy of the NFVO 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. + Shall be returned when a subscription with the + same callbackURI and the same filter already + exits and the policy of the NFVO 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/SOL005_resp.yaml#/responses/303" 400: @@ -1469,18 +1533,14 @@ paths: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: $ref: "../responses/SOL005_resp.yaml#/responses/503" + 504: + $ref: "../responses/SOL005_resp.yaml#/responses/504" get: summary: Query multiple subscriptions. description: > - 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. This method shall support the URI query parameters, - request and response data structures, and response codes. - - This resource represents subscriptions. - The client can use this resource to subscribe to notifications related to NSD - management and to query its subscriptions. + 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: - name: filter in: query @@ -1512,14 +1572,19 @@ paths: description: > 200 OK - The list of subscriptions has been queried successfully. - The response body shall contain in an array the representations of - all active subscriptions of the functional block that invokes the method, - i.e. zero or more representations of NSD management subscriptions as - defined in clause 5.5.2.8. - If the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 - of ETSI GS NFV SOL 013 for this resource, inclusion of the Link HTTP header - in this response shall follow the provisions in clause 5.4.2.3 of ETSI GS NFV-SOL 013. + The list of subscriptions has been queried + successfully. + The response body shall contain in an array the + representations of all active subscriptions of the + functional block that invokes the method, i.e. zero or + more representations of NSD management + subscriptions as defined in clause 5.5.2.8. + If the NFVO supports alternative 2 (paging) + according to clause 5.4.2.1 of ETSI + GS NFV-SOL 013 for this resource, inclusion of + the Link HTTP header in this response shall follow + the provisions in clause 5.4.2.3 of ETSI GS NFVSOL + 013. headers: Content-Type: description: The MIME type of the body of the response. @@ -1573,6 +1638,8 @@ paths: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: $ref: "../responses/SOL005_resp.yaml#/responses/503" + 504: + $ref: "../responses/SOL005_resp.yaml#/responses/504" ############################################################################### # Individual Subscription # @@ -1666,6 +1733,8 @@ paths: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: $ref: "../responses/SOL005_resp.yaml#/responses/503" + 504: + $ref: "../responses/SOL005_resp.yaml#/responses/504" delete: summary: Terminate Subscription @@ -1729,4 +1798,6 @@ paths: 500: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: - $ref: "../responses/SOL005_resp.yaml#/responses/503" \ No newline at end of file + $ref: "../responses/SOL005_resp.yaml#/responses/503" + 504: + $ref: "../responses/SOL005_resp.yaml#/responses/504" \ No newline at end of file diff --git a/src/SOL005/NSLifecycleManagement/NSLifecycleManagement.yaml b/src/SOL005/NSLifecycleManagement/NSLifecycleManagement.yaml index da14b00..cfbc3ee 100644 --- a/src/SOL005/NSLifecycleManagement/NSLifecycleManagement.yaml +++ b/src/SOL005/NSLifecycleManagement/NSLifecycleManagement.yaml @@ -82,7 +82,8 @@ paths: description: > 201 Created - A NS Instance identifier has been created successfully. + A NS Instance identifier has been created + successfully. The response body shall contain a representation of the created NS instance, as defined in clause 6.5.2.8. The HTTP response shall include a "Location" HTTP @@ -131,6 +132,8 @@ paths: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: $ref: "../responses/SOL005_resp.yaml#/responses/503" + 504: + $ref: "../responses/SOL005_resp.yaml#/responses/504" get: summary: Query multiple NS instances. description: > @@ -208,12 +211,16 @@ paths: description: > 200 OK - Information about zero or more NS instances has been queried successfully. - The response body shall contain in an array the representations of - zero or more NS instances, as defined in clause 6.5.2.8. - If the NFVO 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 5.4.2.3 of ETSI GS NFV-SOL 013. + Information about zero or more NS instances has + been queried successfully. + The response body shall contain in an array the + representations of zero or more NS instances, as + defined in clause 6.5.2.8. + If the NFVO 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 5.4.2.3 of ETSI + GS NFV-SOL 013. headers: Content-Type: description: The MIME type of the body of the response. @@ -266,6 +273,8 @@ paths: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: $ref: "../responses/SOL005_resp.yaml#/responses/503" + 504: + $ref: "../responses/SOL005_resp.yaml#/responses/504" ############################################################################### # Individual NS instance # @@ -355,14 +364,14 @@ paths: $ref: "../responses/SOL005_resp.yaml#/responses/405" 406: $ref: "../responses/SOL005_resp.yaml#/responses/406" - 409: - $ref: "../responses/SOL005_resp.yaml#/responses/409" 416: $ref: "../responses/SOL005_resp.yaml#/responses/416" 500: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: $ref: "../responses/SOL005_resp.yaml#/responses/503" + 504: + $ref: "../responses/SOL005_resp.yaml#/responses/504" delete: summary: Delete NS instance resource. @@ -406,6 +415,16 @@ paths: 406: $ref: "../responses/SOL005_resp.yaml#/responses/406" 409: + description: > + 409 CONFLICT + + Error: The operation cannot be executed currently, + due to a conflict with the state of the resource. + Typically, this is due to the fact that the NS instance + resource is in INSTANTIATED state. + The response body shall contain a ProblemDetails + structure, in which the "detail" attribute shall convey + more information about the error. $ref: "../responses/SOL005_resp.yaml#/responses/409" 412: $ref: "../responses/SOL005_resp.yaml#/responses/412" @@ -413,6 +432,8 @@ paths: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: $ref: "../responses/SOL005_resp.yaml#/responses/503" + 504: + $ref: "../responses/SOL005_resp.yaml#/responses/504" ############################################################################### # Instantiate NS task # @@ -467,7 +488,17 @@ paths: Parameters for the instantiate NS operation, as defined in clause 6.5.2.10. responses: 202: - $ref: "../responses/SOL005_resp.yaml#/responses/202-with-Location" + description: > + 202 ACCEPTED + + The request has been accepted for processing, but + the processing has not been completed. + The response body shall be empty. + The HTTP response shall include a "Location" HTTP + header that contains the URI of the newly-created + "NS LCM operation occurrence" resource + corresponding to the operation. + $ref: "../responses/SOL005_resp.yaml#/responses/202" 400: $ref: "../responses/SOL005_resp.yaml#/responses/400" 401: @@ -481,6 +512,17 @@ paths: 406: $ref: "../responses/SOL005_resp.yaml#/responses/406" 409: + description: > + 409 CONFLICT + + Error: The operation cannot be executed currently, + due to a conflict with the state of the resource. + Typically, this is due to the fact that the NS instance + resource is in the INSTANTIATED state, or that + another lifecycle management operation is ongoing. + The response body shall contain a ProblemDetails + structure, in which the "detail" attribute shall convey + more information about the error. $ref: "../responses/SOL005_resp.yaml#/responses/409" 416: $ref: "../responses/SOL005_resp.yaml#/responses/416" @@ -488,6 +530,8 @@ paths: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: $ref: "../responses/SOL005_resp.yaml#/responses/503" + 504: + $ref: "../responses/SOL005_resp.yaml#/responses/504" ############################################################################### # Scale NS task # @@ -542,7 +586,17 @@ paths: Parameters for the scale NS operation, as defined in clause 6.5.2.13. responses: 202: - $ref: "../responses/SOL005_resp.yaml#/responses/202-with-Location" + description: > + 202 ACCEPTED + + The request has been accepted for processing, but + the processing has not been completed. + The response body shall be empty. + The HTTP response shall include a "Location" HTTP + header that contains the URI of the newly-created + "NS lifecycle operation occurrence" resource + corresponding to the operation. + $ref: "../responses/SOL005_resp.yaml#/responses/202" 400: $ref: "../responses/SOL005_resp.yaml#/responses/400" 401: @@ -556,11 +610,24 @@ paths: 406: $ref: "../responses/SOL005_resp.yaml#/responses/406" 409: + description: > + 409 CONFLICT + + Error: The operation cannot be executed currently, + due to a conflict with the state of the resource. + Typically, this is due to the fact that the NS instance + resource is in NOT_INSTANTIATED state, or that + another lifecycle management operation is ongoing. + The response body shall contain a ProblemDetails + structure, in which the "detail" attribute shall convey + more information about the error. $ref: "../responses/SOL005_resp.yaml#/responses/409" 500: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: $ref: "../responses/SOL005_resp.yaml#/responses/503" + 504: + $ref: "../responses/SOL005_resp.yaml#/responses/504" ############################################################################### # Update NS task # @@ -616,7 +683,17 @@ paths: Parameters for the update NS operation, as defined in clause 6.5.2.11. responses: 202: - $ref: "../responses/SOL005_resp.yaml#/responses/202-with-Location" + description: > + 202 ACCEPTED + + The request has been accepted for processing, but + the processing has not been completed. + The response body shall be empty. + The HTTP response shall include a "Location" HTTP + header that contains the URI of the newly-created + "NS lifecycle operation occurrence" resource + corresponding to the operation. + $ref: "../responses/SOL005_resp.yaml#/responses/202" 400: $ref: "../responses/SOL005_resp.yaml#/responses/400" 401: @@ -630,11 +707,24 @@ paths: 406: $ref: "../responses/SOL005_resp.yaml#/responses/406" 409: + description: > + 409 CONFLICT + + Error: The operation cannot be executed currently, + due to a conflict with the state of the resource. + Typically, this is due to the fact that the NS instance + resource is in NOT_INSTANTIATED state, or that + another lifecycle management operation is ongoing. + The response body shall contain a ProblemDetails + structure, in which the "detail" attribute shall convey + more information about the error. $ref: "../responses/SOL005_resp.yaml#/responses/409" 500: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: $ref: "../responses/SOL005_resp.yaml#/responses/503" + 504: + $ref: "../responses/SOL005_resp.yaml#/responses/504" ############################################################################### # Heal NS task # @@ -692,7 +782,17 @@ paths: Parameters for the heal NS operation, as defined in clause 6.5.2.12. responses: 202: - $ref: "../responses/SOL005_resp.yaml#/responses/202-with-Location" + description: > + 202 ACCEPTED + + The request has been accepted for processing, but + the processing has not been completed. + The response body shall be empty. + The HTTP response shall include a "Location" HTTP + header that contains the URI of the newly-created + "NS lifecycle operation occurrence" resource + corresponding to the operation. + $ref: "../responses/SOL005_resp.yaml#/responses/202" 400: $ref: "../responses/SOL005_resp.yaml#/responses/400" 401: @@ -706,11 +806,24 @@ paths: 406: $ref: "../responses/SOL005_resp.yaml#/responses/406" 409: + description: > + 409 CONFLICT + + Error: The operation cannot be executed currently, + due to a conflict with the state of the resource. + Typically, this is due to the fact that the NS instance + resource is in NOT_INSTANTIATED state, or that + another lifecycle management operation is ongoing. + The response body shall contain a ProblemDetails + structure, in which the "detail" attribute shall convey + more information about the error. $ref: "../responses/SOL005_resp.yaml#/responses/409" 500: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: $ref: "../responses/SOL005_resp.yaml#/responses/503" + 504: + $ref: "../responses/SOL005_resp.yaml#/responses/504" ############################################################################### # Terminate NS task # @@ -772,7 +885,17 @@ paths: The terminate NS request parameters, as defined in clause 6.5.2.14. responses: 202: - $ref: "../responses/SOL005_resp.yaml#/responses/202-with-Location" + description: > + 202 ACCEPTED + + Shall be returned when the request has been + accepted for processing. + The response body shall be empty. + The HTTP response shall include a "Location" HTTP + header that contains the URI of the newly-created + "NS lifecycle operation occurrence" resource + corresponding to the operation. + $ref: "../responses/SOL005_resp.yaml#/responses/202" 400: $ref: "../responses/SOL005_resp.yaml#/responses/400" 401: @@ -786,11 +909,24 @@ paths: 406: $ref: "../responses/SOL005_resp.yaml#/responses/406" 409: + description: > + 409 CONFLICT + + Error: The operation cannot be executed currently, + due to a conflict with the state of the resource. + Typically, this is due to the fact that the NS instance + resource is in NOT_INSTANTIATED state, or that + another lifecycle management operation is ongoing. + The response body shall contain a ProblemDetails + structure, in which the "detail" attribute shall convey + more information about the error. $ref: "../responses/SOL005_resp.yaml#/responses/409" 500: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: $ref: "../responses/SOL005_resp.yaml#/responses/503" + 504: + $ref: "../responses/SOL005_resp.yaml#/responses/504" ############################################################################### # NS LCM operation occurrences # @@ -934,12 +1070,12 @@ paths: $ref: "../responses/SOL005_resp.yaml#/responses/405" 406: $ref: "../responses/SOL005_resp.yaml#/responses/406" - 409: - $ref: "../responses/SOL005_resp.yaml#/responses/409" 500: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: $ref: "../responses/SOL005_resp.yaml#/responses/503" + 504: + $ref: "../responses/SOL005_resp.yaml#/responses/504" ############################################################################### # Individual NS lifecycle operation occurrence # @@ -1035,14 +1171,14 @@ paths: $ref: "../responses/SOL005_resp.yaml#/responses/405" 406: $ref: "../responses/SOL005_resp.yaml#/responses/406" - 409: - $ref: "../responses/SOL005_resp.yaml#/responses/409" 416: $ref: "../responses/SOL005_resp.yaml#/responses/416" 500: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: $ref: "../responses/SOL005_resp.yaml#/responses/503" + 504: + $ref: "../responses/SOL005_resp.yaml#/responses/504" ############################################################################### # Retry operation task # @@ -1085,7 +1221,13 @@ paths: type: string responses: 202: - $ref: "../responses/SOL005_resp.yaml#/responses/202-with-Location-empty" + description: > + 202 ACCEPTED + + The request has been accepted for processing, but + processing has not been completed. + The response shall have an empty payload body. + $ref: "../responses/SOL005_resp.yaml#/responses/202" 400: $ref: "../responses/SOL005_resp.yaml#/responses/400" 401: @@ -1093,17 +1235,50 @@ paths: 403: $ref: "../responses/SOL005_resp.yaml#/responses/403" 404: + description: > + 404 NOT FOUND + + Error: The API producer did not find a current + representation for the target resource or is not willing + to disclose that one exists. + The general cause for this error and its handling is + specified in clause 6.4 of ETSI GS NFV-SOL 013, + including rules for the presence of the response body. + Specifically in case of this task resource, the reason + can also be that the task is not supported for the NS + LCM operation occurrence represented by the parent + resource, and that the task resource consequently + does not exist. + In this case, the response body shall be present, and + shall contain a ProblemDetails structure, in which the + "detail" attribute shall convey more information about + the error. $ref: "../responses/SOL005_resp.yaml#/responses/404" 405: $ref: "../responses/SOL005_resp.yaml#/responses/405" 406: $ref: "../responses/SOL005_resp.yaml#/responses/406" 409: + description: > + 409 CONFLICT + + Error: The operation cannot be executed currently, + due to a conflict with the state of the NS LCM + operation occurrence resource. + Typically, this is due to the fact that the NS LCM + operation occurrence is not in FAILED_TEMP state, or + another error handling action is starting, such as + rollback or fail. + The response body shall contain a ProblemDetails + structure, in which the "detail" attribute shall convey + more information about the error. $ref: "../responses/SOL005_resp.yaml#/responses/409" 500: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: $ref: "../responses/SOL005_resp.yaml#/responses/503" + 504: + $ref: "../responses/SOL005_resp.yaml#/responses/504" ############################################################################### # Rollback a NS lifecycle management operation occurrence. # @@ -1146,7 +1321,11 @@ paths: type: string responses: 202: - $ref: "../responses/SOL005_resp.yaml#/responses/202-with-Location-empty" + description: > + The request has been accepted for processing, but + processing has not been completed. + The response shall have an empty payload body. + $ref: "../responses/SOL005_resp.yaml#/responses/202" 400: $ref: "../responses/SOL005_resp.yaml#/responses/400" 401: @@ -1154,17 +1333,51 @@ paths: 403: $ref: "../responses/SOL005_resp.yaml#/responses/403" 404: + description: > + 404 NOT FOUND + + Error: The API producer did not find a current + representation for the target resource or is not willing + to disclose that one exists. + The general cause for this error and its handling is + specified in clause 6.4 of ETSI GS NFV-SOL 013 + [16], including rules for the presence of the response + body. + Specifically, in case of this task resource, the reason + can also be that the task is not supported for the NS + LCM operation occurrence represented by the parent + resource, and that the task resource consequently + does not exist. + In this case, the response body shall be present, and + shall contain a ProblemDetails structure, in which the + "detail" attribute shall convey more information about + the error. $ref: "../responses/SOL005_resp.yaml#/responses/404" 405: $ref: "../responses/SOL005_resp.yaml#/responses/405" 406: $ref: "../responses/SOL005_resp.yaml#/responses/406" 409: + description: > + 409 CONFLICT + + Error: The operation cannot be executed currently, + due to a conflict with the state of the NS LCM + operation occurrence resource. + Typically, this is due to the fact that the NS LCM + operation occurrence is not in FAILED_TEMP state, + or another error handling action is starting, such as + retry or fail. + The response body shall contain a ProblemDetails + structure, in which the "detail" attribute shall convey + more information about the error. $ref: "../responses/SOL005_resp.yaml#/responses/409" 500: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: $ref: "../responses/SOL005_resp.yaml#/responses/503" + 504: + $ref: "../responses/SOL005_resp.yaml#/responses/504" ############################################################################### # Continue a NS lifecycle management operation occurrence. # @@ -1201,7 +1414,13 @@ paths: type: string responses: 202: - $ref: "../responses/SOL005_resp.yaml#/responses/202-with-Location-empty" + description: > + 202 ACCEPTED + + The request has been accepted for processing, but + processing has not been completed. + The response shall have an empty payload body. + $ref: "../responses/SOL005_resp.yaml#/responses/202" 400: $ref: "../responses/SOL005_resp.yaml#/responses/400" 401: @@ -1209,17 +1428,51 @@ paths: 403: $ref: "../responses/SOL005_resp.yaml#/responses/403" 404: + description: > + 404 NOT FOUND + + Error: The API producer did not find a current + representation for the target resource or is not willing + to disclose that one exists. + The general cause for this error and its handling is + specified in clause 6.4 of ETSI GS NFV-SOL 013 + [16], including rules for the presence of the response + body. + Specifically, in case of this task resource, the reason + can also be that the task is not supported for the NS + LCM operation occurrence represented by the parent + resource, and that the task resource consequently + does not exist. + In this case, the response body shall be present, and + shall contain a ProblemDetails structure, in which the + "detail" attribute shall convey more information about + the error. $ref: "../responses/SOL005_resp.yaml#/responses/404" 405: $ref: "../responses/SOL005_resp.yaml#/responses/405" 406: $ref: "../responses/SOL005_resp.yaml#/responses/406" 409: + description: > + 409 CONFLICT + + Error: The operation cannot be executed currently, + due to a conflict with the state of the NS LCM + operation occurrence resource. + Typically, this is due to the fact that the NS LCM + operation occurrence is not in FAILED_TEMP state, + or another error handling action is starting, such as + retry or fail. + The response body shall contain a ProblemDetails + structure, in which the "detail" attribute shall convey + more information about the error. $ref: "../responses/SOL005_resp.yaml#/responses/409" 500: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: $ref: "../responses/SOL005_resp.yaml#/responses/503" + 504: + $ref: "../responses/SOL005_resp.yaml#/responses/504" ############################################################################### # Fail operation task # @@ -1307,17 +1560,50 @@ paths: 403: $ref: "../responses/SOL005_resp.yaml#/responses/403" 404: + description: > + 404 NOT FOUND + + Error: The API producer did not find a current + representation for the target resource or is not willing + to disclose that one exists. + The general cause for this error and its handling is + specified in clause 6.4 of ETSI GS NFV-SOL 013, + including rules for the presence of the response body. + Specifically in case of this task resource, the reason + can also be that the task is not supported for the NS + LCM operation occurrence represented by the parent + resource, and that the task resource consequently + does not exist. + In this case, the response body shall be present, and + shall contain a ProblemDetails structure, in which the + "detail" attribute shall convey more information about + the error. $ref: "../responses/SOL005_resp.yaml#/responses/404" 405: $ref: "../responses/SOL005_resp.yaml#/responses/405" 406: $ref: "../responses/SOL005_resp.yaml#/responses/406" 409: + description: > + 409 CONFLICT + + Error: The operation cannot be executed currently, + due to a conflict with the state of the NS LCM + operation occurrence resource. + Typically, this is due to the fact that the NS LCM + operation occurrence is not in FAILED_TEMP state, or + another error handling action is starting, such as retry + or rollback. + The response body shall contain a ProblemDetails + structure, in which the "detail" attribute shall convey + more information about the error. $ref: "../responses/SOL005_resp.yaml#/responses/409" 500: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: $ref: "../responses/SOL005_resp.yaml#/responses/503" + 504: + $ref: "../responses/SOL005_resp.yaml#/responses/504" ############################################################################### # Cancel operation task # @@ -1384,7 +1670,13 @@ paths: "forceful" cancellation. responses: 202: - $ref: "../responses/SOL005_resp.yaml#/responses/202-with-Location-empty" + description: > + 202 ACCEPTED + + The request has been accepted for processing, but + processing has not been completed. + The response shall have an empty entity body. + $ref: "../responses/SOL005_resp.yaml#/responses/202" 400: $ref: "../responses/SOL005_resp.yaml#/responses/400" 401: @@ -1392,17 +1684,49 @@ paths: 403: $ref: "../responses/SOL005_resp.yaml#/responses/403" 404: + description: > + 404 NOT FOUND + + Error: The API producer did not find a current + representation for the target resource or is not willing + to disclose that one exists. + The general cause for this error and its handling is + specified in clause 6.4 of ETSI GS NFV-SOL 013, + including rules for the presence of the response body. + Specifically, in case of this task resource, the reason + can also be that the task is not supported for the NS + LCM operation occurrence represented by the parent + resource, and that the task resource consequently + does not exist. + In this case, the response body shall be present, and + shall contain a ProblemDetails structure, in which the + "detail" attribute shall convey more information about + the error. $ref: "../responses/SOL005_resp.yaml#/responses/404" 405: $ref: "../responses/SOL005_resp.yaml#/responses/405" 406: $ref: "../responses/SOL005_resp.yaml#/responses/406" 409: + description: > + 409 CONFLICT + + Error: The operation cannot be executed currently, + due to a conflict with the state of the NS LCM + operation occurrence resource. + Typically, this is due to the fact that the operation + occurrence is not in STARTING, PROCESSING or + ROLLING_BACK state. + The response body shall contain a ProblemDetails + structure, in which the "detail" attribute shall convey + more information about the error. $ref: "../responses/SOL005_resp.yaml#/responses/409" 500: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: $ref: "../responses/SOL005_resp.yaml#/responses/503" + 504: + $ref: "../responses/SOL005_resp.yaml#/responses/504" ############################################################################### # Subscriptions # @@ -1491,6 +1815,16 @@ paths: maximum: 1 minimum: 1 303: + description: > + 303 SEE OTHER + + A subscription with the same callbackURI and the + same filter already exits and the policy of the + NFVO 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/SOL005_resp.yaml#/responses/303" 400: $ref: "../responses/SOL005_resp.yaml#/responses/400" @@ -1508,6 +1842,9 @@ paths: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: $ref: "../responses/SOL005_resp.yaml#/responses/503" + 504: + $ref: "../responses/SOL005_resp.yaml#/responses/504" + get: summary: Query multiple subscriptions. description: > @@ -1600,6 +1937,8 @@ paths: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: $ref: "../responses/SOL005_resp.yaml#/responses/503" + 504: + $ref: "../responses/SOL005_resp.yaml#/responses/504" ############################################################################### # Individual subscription # @@ -1686,6 +2025,8 @@ paths: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: $ref: "../responses/SOL005_resp.yaml#/responses/503" + 504: + $ref: "../responses/SOL005_resp.yaml#/responses/504" delete: summary: Terminate a subscription. @@ -1696,7 +2037,7 @@ paths: responses: 204: description: > - 204 No Content + 204 NO CONTENT The subscription resource has been deleted successfully. The response body shall be empty. @@ -1728,4 +2069,6 @@ paths: 500: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: - $ref: "../responses/SOL005_resp.yaml#/responses/503" \ No newline at end of file + $ref: "../responses/SOL005_resp.yaml#/responses/503" + 504: + $ref: "../responses/SOL005_resp.yaml#/responses/504" \ No newline at end of file diff --git a/src/SOL005/NSLifecycleManagementNotification/NSLifecycleManagementNotification.yaml b/src/SOL005/NSLifecycleManagementNotification/NSLifecycleManagementNotification.yaml index ddfb688..35c4b73 100644 --- a/src/SOL005/NSLifecycleManagementNotification/NSLifecycleManagementNotification.yaml +++ b/src/SOL005/NSLifecycleManagementNotification/NSLifecycleManagementNotification.yaml @@ -107,10 +107,6 @@ paths: $ref: "../responses/SOL005_resp.yaml#/responses/405" 406: $ref: "../responses/SOL005_resp.yaml#/responses/406" - 409: - $ref: "../responses/SOL005_resp.yaml#/responses/409" - 416: - $ref: "../responses/SOL005_resp.yaml#/responses/416" 500: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: @@ -179,10 +175,6 @@ paths: $ref: "../responses/SOL005_resp.yaml#/responses/405" 406: $ref: "../responses/SOL005_resp.yaml#/responses/406" - 409: - $ref: "../responses/SOL005_resp.yaml#/responses/409" - 416: - $ref: "../responses/SOL005_resp.yaml#/responses/416" 500: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: @@ -264,10 +256,6 @@ paths: $ref: "../responses/SOL005_resp.yaml#/responses/405" 406: $ref: "../responses/SOL005_resp.yaml#/responses/406" - 409: - $ref: "../responses/SOL005_resp.yaml#/responses/409" - 416: - $ref: "../responses/SOL005_resp.yaml#/responses/416" 500: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: @@ -336,10 +324,6 @@ paths: $ref: "../responses/SOL005_resp.yaml#/responses/405" 406: $ref: "../responses/SOL005_resp.yaml#/responses/406" - 409: - $ref: "../responses/SOL005_resp.yaml#/responses/409" - 416: - $ref: "../responses/SOL005_resp.yaml#/responses/416" 500: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: @@ -422,10 +406,6 @@ paths: $ref: "../responses/SOL005_resp.yaml#/responses/405" 406: $ref: "../responses/SOL005_resp.yaml#/responses/406" - 409: - $ref: "../responses/SOL005_resp.yaml#/responses/409" - 416: - $ref: "../responses/SOL005_resp.yaml#/responses/416" 500: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: @@ -494,10 +474,6 @@ paths: $ref: "../responses/SOL005_resp.yaml#/responses/405" 406: $ref: "../responses/SOL005_resp.yaml#/responses/406" - 409: - $ref: "../responses/SOL005_resp.yaml#/responses/409" - 416: - $ref: "../responses/SOL005_resp.yaml#/responses/416" 500: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: diff --git a/src/SOL005/definitions/SOL005_def.yaml b/src/SOL005/definitions/SOL005_def.yaml index 9928c9a..05e1def 100644 --- a/src/SOL005/definitions/SOL005_def.yaml +++ b/src/SOL005/definitions/SOL005_def.yaml @@ -1,6 +1,8 @@ # Copyright (c) ETSI 2017. # https://forge.etsi.org/etsi-forge-copyright-notice.txt + definitions: + Identifier: description: > An identifier with the intention of being globally unique. @@ -234,6 +236,23 @@ definitions: complements the ResourceHandle. type: string + IdentifierInNs: + description: > + An identifier that is unique with respect to a NS. Representation: string of variable length. + type: string + + IdentifierInNsd: + description: > + An identifier that is unique within a NS descriptor. Representation: string of variable + length. + type: string + + IdentifierInPnf: + description: > + An Identifier that is unique within respect to a PNF. Representation: string of variable + length. + type: string + IdentifierInVim: description: > An identifier maintained by the VIM or other resource provider. diff --git a/src/SOL005/responses/SOL005_resp.yaml b/src/SOL005/responses/SOL005_resp.yaml index 9fe3455..579a026 100644 --- a/src/SOL005/responses/SOL005_resp.yaml +++ b/src/SOL005/responses/SOL005_resp.yaml @@ -3,16 +3,7 @@ responses: - 202-with-Location: - description: > - 202 ACCEPTED - - The request has been accepted for processing, but the processing has not - been completed. The response body shall be empty. - The HTTP response shall include a "Location" HTTP - header that contains the URI of the newly-created - "NS lifecycle operation occurrence" resource - corresponding to the operation. + 202: headers: Content-Type: description: The MIME type of the body of the response. @@ -39,38 +30,8 @@ responses: type: string maximum: 1 minimum: 1 - schema: - $ref: "../NSLifecycleManagement/definitions/SOL005NSLifecycleManagement_def.yaml#/definitions/NsInstance" - - 202-with-Location-empty: - description: > - 202 ACCEPTED - - The request has been 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 - "NS Descriptor operation occurrence" resource corresponding to the - operation. - The response body shall be empty. - 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 - Version: - description: > - Version of the API used in the response. - type: string - maximum: 1 - minimum: 1 206: - description: > - 206 PARTIAL CONTENT headers: Content-Type: description: > @@ -102,8 +63,6 @@ responses: $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" 303: - description: > - 303 SEE OTHER headers: Content-Type: description: The MIME type of the body of the response. @@ -334,8 +293,6 @@ responses: $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" 409: - description: > - 409 CONFLICT headers: Content-Type: description: The MIME type of the body of the response. -- GitLab