Loading src/SOL005/NSDManagement/definitions/SOL005NSDescriptorManagement_def.yaml +6 −1 Viewed Changes for src/SOL005/NSDManagement/definitions/SOL005NSDescriptorManagement_def.yaml: 6 added lines, 1 removed line. Original line number Diff line number Diff line Loading @@ -98,7 +98,7 @@ definitions: onboardingFailureDetails: description: > Failure details of current on boarding procedure. See clause 4.3.5.3 for the details of "ProblemDetails" clause 6.3 of ETSI GS NFV-SOL 013 for the details of "ProblemDetails" structure. It shall be present when the "nsdOnboardingState" attribute is CREATED and the uploading or Loading Loading @@ -207,6 +207,7 @@ definitions: onboardingFailureDetails: description: > Failure details of current on-boarding procedure. See clause 6.3 of ETSI GS NFV-SOL 013 for the details of "ProblemDetails" structure. It shall be present when the pnfdOnboardingState attribute is CREATED and the uploading or processing fails in the NFVO. Loading Loading @@ -257,6 +258,10 @@ definitions: description: > The URI of the endpoint to send the notification to. authentication: description: > Authentication parameters to configure the use of Authorization when sending notifications corresponding to this subscription, as defined in clause 8.3.4 of ETSI GS NFV-SOL 013. This attribute shall only be present if the subscriber requires authorization of notifications. $ref: "../../definitions/SOL005_def.yaml#/definitions/SubscriptionAuthentication" description: > This type represents a subscription request related to notifications Loading src/SOL005/NSDManagement/NSDManagement.yaml +261 −176 Viewed Changes for src/SOL005/NSDManagement/NSDManagement.yaml: 261 added lines, 176 removed lines. Original line number Diff line number Diff line Loading @@ -17,8 +17,8 @@ info: name: "NFV-SOL WG" externalDocs: description: ETSI GS NFV-SOL 005 V2.5.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.05.01_60/gs_NFV-SOL005v020501p.pdf description: ETSI GS NFV-SOL 005 V2.6.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.06.01_60/gs_NFV-SOL005v020601p.pdf basePath: /nsd/v1 Loading Loading @@ -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: > Loading Loading @@ -90,11 +90,14 @@ paths: description: > 201 CREATED An NS descriptor resource was 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: Loading Loading @@ -134,21 +137,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" 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 required: false type: string description: > Attribute-based filtering expression according to clause 4.3.2. Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013. The NFVO shall support receiving this filtering parameter as part of the URI query string. The OSS/BSS may supply this parameter. All attribute names that appear in the NsdInfo and in data types referenced from it shall Loading @@ -158,28 +160,29 @@ paths: required: false type: string description: > Include all complex attributes in the response. See clause 4.3.3 for details. Include all complex attributes in the response. See clause 5.3 of ETSI GS NFV SOL 013 for details. The NFVO shall support this parameter. - name: fields in: query required: false type: string description: > Complex attributes to be included into the response. See clause 4.3.3 for Complex attributes to be included into the response. See clause 5.3 of ETSI GS NFV SOL 013 for details. The NFVO should support this parameter. - name: exclude_fields in: query required: false type: string description: > Complex attributes to be excluded from the response. See clause 4.3.3 for Complex attributes to be excluded from the response. See clause 5.3 of ETSI GS NFV SOL 013 for details. The NFVO should support this parameter. - name: exclude_default in: query required: false type: string description: > Indicates to exclude the following complex attributes from the response. See clause 4.3.3 for details. Indicates to exclude the following complex attributes from the response. See clause 5.3 of ETSI GS NFV SOL 013 for details. The VNFM shall support this parameter. The following attributes shall be excluded from the NsdInfo structure in the response body if this parameter is provided, or none of the parameters "all_fields," "fields", "exclude_fields", "exclude_default" Loading @@ -188,7 +191,8 @@ paths: in: query description: > Marker to obtain the next page of a paged response. Shall be supported by the NFVO if the NFVO supports alternative 2 (paging) according to clause 4.7.2.1 for this resource. if the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource. required: false type: string - name: Accept Loading @@ -204,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. Loading Loading @@ -254,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 # Loading Loading @@ -285,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: > Loading @@ -302,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: Loading Loading @@ -342,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 Loading @@ -375,7 +385,7 @@ paths: description: > 200 OK The operation was completed successfully. The operation has been completed successfully. The response body shall contain attribute modifications for an 'Individual NS Descriptor' resource (see clause 5.5.2.6). headers: Loading Loading @@ -416,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: Loading @@ -428,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. Loading Loading @@ -488,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 # Loading Loading @@ -528,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: > Loading @@ -568,15 +587,16 @@ paths: description: > 200 OK On success, the content of the NSD is returned. 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. Loading @@ -601,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" Loading @@ -618,48 +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 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: > Loading @@ -677,13 +714,16 @@ paths: description: > 202 ACCEPTED The NSD content was 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. Loading @@ -708,7 +748,8 @@ paths: description: > 204 NO CONTENT The NSD content was successfully uploaded and validated (synchronous mode). The NSD content successfully uploaded and validated (synchronous mode). The response body shall be empty. headers: WWW-Authenticate: Loading Loading @@ -741,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 # Loading Loading @@ -802,13 +849,14 @@ paths: description: > 201 CREATED A PNF descriptor resource was 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: Loading Loading @@ -848,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. Loading @@ -860,7 +910,7 @@ paths: required: false type: string description: > Attribute-based filtering expression according to clause 4.3.2. Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013. The NFVO shall support receiving this filtering parameter as part of the URI query string. The OSS/BSS may supply this parameter. All attribute names that appear in the PnfdInfo and in data types Loading @@ -870,21 +920,21 @@ paths: required: false type: string description: > Include all complex attributes in the response. See clause 4.3.3 for details. Include all complex attributes in the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFVO shall support this parameter. - name: fields in: query required: false type: string description: > Complex attributes to be included into the response. See clause 4.3.3 for Complex attributes to be included into the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFVO should support this parameter. - name: exclude_fields in: query required: false type: string description: > Complex attributes to be excluded from the response. See clause 4.3.3 for Complex attributes to be excluded from the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFVO should support this parameter. - name: exclude_default in: query Loading @@ -892,7 +942,7 @@ paths: type: string description: > Indicates to exclude the following complex attributes from the response. See clause 4.3.3 for details. The NFVO shall support this parameter. clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFVO shall support this parameter. The following attributes shall be excluded from the PnfdInfo structure in the response body if this parameter is provided, or none of the parameters "all_fields," "fields", "exclude_fields", "exclude_default" are provided: Loading @@ -903,16 +953,22 @@ paths: required: false description: > Marker to obtain the next page of a paged response. Shall be supported by the NFVO if the NFVO supports alternative 2 (paging) according to clause 4.7.2.1 for this resource. if the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource. responses: 200: description: > 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.2 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. Loading Loading @@ -965,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 # Loading @@ -983,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 Loading Loading @@ -1015,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. Loading Loading @@ -1054,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. Loading Loading @@ -1087,8 +1145,9 @@ paths: description: > 200 OK The operation was completed successfully. The response body shall contain attribute modifications for an 'Individual PNF Descriptor' The operation has been completed successfully. 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" Loading Loading @@ -1131,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. Loading @@ -1138,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: > Loading Loading @@ -1180,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 # Loading Loading @@ -1228,9 +1290,12 @@ paths: description: > 200 OK On success, the content of the PNFD is returned. 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. Loading Loading @@ -1267,15 +1332,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 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. Loading @@ -1297,7 +1368,7 @@ paths: description: > 204 NO CONTENT The PNFD content was successfully uploaded and validated. The PNFD content successfully uploaded and validated. The response body shall be empty. headers: WWW-Authenticate: Loading Loading @@ -1330,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" Loading Loading @@ -1364,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: > Loading Loading @@ -1407,10 +1474,13 @@ paths: description: > 201 CREATED The subscription was 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: Loading Loading @@ -1438,10 +1508,13 @@ paths: 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. 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: Loading @@ -1460,25 +1533,21 @@ 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 required: false type: string description: > Attribute filtering expression according to clause 4.3.2. Attribute filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013. The NFVO shall support receiving this parameter as part of the URI query string. The OSS/BSS may supply this parameter. All attribute names that appear in the NsdmSubscription and in data types referenced Loading @@ -1489,7 +1558,8 @@ paths: type: string description: > Marker to obtain the next page of a paged response. Shall be supported by the NFVO if the NFVO supports alternative 2 (paging) according to clause 4.7.2.1 for this resource. if the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource. - name: Accept description: > Content-Types that are acceptable for the response. Loading @@ -1502,10 +1572,19 @@ paths: description: > 200 OK The list of subscriptions was queried successfully. The response body shall contain the representations of all active subscriptions of the functional block that invokes the method. 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. Loading Loading @@ -1559,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 # Loading Loading @@ -1652,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 Loading Loading @@ -1683,7 +1766,7 @@ paths: description: > 204 NO CONTENT The subscription resource was deleted successfully. The subscription resource has been deleted successfully. The response body shall be empty. headers: WWW-Authenticate: Loading Loading @@ -1716,3 +1799,5 @@ paths: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: $ref: "../responses/SOL005_resp.yaml#/responses/503" 504: $ref: "../responses/SOL005_resp.yaml#/responses/504" No newline at end of file src/SOL005/NSDManagementNotification/definitions/SOL005NSDescriptorManagementNotification_def.yaml +6 −0 Viewed Changes for src/SOL005/NSDManagementNotification/definitions/SOL005NSDescriptorManagementNotification_def.yaml: 6 added lines, 0 removed lines. Original line number Diff line number Diff line Loading @@ -67,6 +67,9 @@ definitions: nsdId: $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" onboardingFailureDetails: description: > Failure details of current onboarding procedure. See clause 6.3 of ETSI GS NFV-SOL 013 for the details of "ProblemDetails" structure. $ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails" _links: $ref: "#/definitions/NsdmLinks" Loading Loading @@ -222,6 +225,9 @@ definitions: pnfdId: $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" onboardingFailureDetails: description: > Failure details of current onboarding procedure. See clause 6.3 of ETSI GS NFV-SOL 013 for the details of "ProblemDetails" structure. $ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails" _links: $ref: "#/definitions/PnfdmLinks" Loading src/SOL005/NSDManagementNotification/NSDManagementNotification.yaml +16 −16 Viewed Changes for src/SOL005/NSDManagementNotification/NSDManagementNotification.yaml: 16 added lines, 16 removed lines. Original line number Diff line number Diff line Loading @@ -14,8 +14,8 @@ info: url: https://forge.etsi.org/etsi-forge-copyright-notice.txt externalDocs: description: ETSI GS NFV-SOL 005 V2.5.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.05.01_60/gs_NFV-SOL005v020501p.pdf description: ETSI GS NFV-SOL 005 V2.6.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.06.01_60/gs_NFV-SOL005v020601p.pdf basePath: /callback/v1 Loading Loading @@ -86,7 +86,7 @@ paths: description: > 204 NO CONTENT The notification was delivered successfully. Shall be returned when the notification has been delivered successfully. headers: WWW-Authenticate: type: string Loading Loading @@ -143,7 +143,7 @@ paths: description: > 204 NO CONTENT The notification endpoint was tested successfully. Shall be returned when the notification endpoint has been tested successfully. The response body shall be empty. headers: WWW-Authenticate: Loading Loading @@ -234,7 +234,7 @@ paths: description: > 204 NO CONTENT The notification was delivered successfully. Shall be returned when the notification has been delivered successfully. headers: WWW-Authenticate: type: string Loading Loading @@ -291,7 +291,7 @@ paths: description: > 204 NO CONTENT The notification endpoint was tested successfully. Shall be returned when the notification endpoint has been tested successfully. The response body shall be empty. headers: WWW-Authenticate: Loading Loading @@ -382,7 +382,7 @@ paths: description: > 204 NO CONTENT The notification was delivered successfully. Shall be returned when the notification has been delivered successfully. headers: WWW-Authenticate: type: string Loading Loading @@ -439,7 +439,7 @@ paths: description: > 204 NO CONTENT The notification endpoint was tested successfully. Shall be returned when the notification endpoint has been tested successfully. The response body shall be empty. headers: WWW-Authenticate: Loading Loading @@ -530,7 +530,7 @@ paths: description: > 204 NO CONTENT The notification was delivered successfully. Shall be returned when the notification has been delivered successfully. headers: WWW-Authenticate: type: string Loading Loading @@ -587,7 +587,7 @@ paths: description: > 204 NO CONTENT The notification endpoint was tested successfully. Shall be returned when the notification endpoint has been tested successfully. The response body shall be empty. headers: WWW-Authenticate: Loading Loading @@ -678,7 +678,7 @@ paths: description: > 204 NO CONTENT The notification was delivered successfully. Shall be returned when the notification has been delivered successfully. headers: WWW-Authenticate: type: string Loading Loading @@ -735,7 +735,7 @@ paths: description: > 204 NO CONTENT The notification endpoint was tested successfully. Shall be returned when the notification endpoint has been tested successfully. The response body shall be empty. headers: WWW-Authenticate: Loading Loading @@ -826,7 +826,7 @@ paths: description: > 204 NO CONTENT The notification was delivered successfully. Shall be returned when the notification has been delivered successfully. headers: WWW-Authenticate: type: string Loading Loading @@ -883,7 +883,7 @@ paths: description: > 204 NO CONTENT The notification endpoint was tested successfully. Shall be returned when the notification endpoint has been tested successfully. The response body shall be empty. headers: WWW-Authenticate: Loading Loading @@ -974,7 +974,7 @@ paths: description: > 204 NO CONTENT The notification was delivered successfully. Shall be returned when the notification has been delivered successfully. headers: WWW-Authenticate: type: string Loading Loading @@ -1031,7 +1031,7 @@ paths: description: > 204 NO CONTENT The notification endpoint was tested successfully. Shall be returned when the notification endpoint has been tested successfully. The response body shall be empty. headers: WWW-Authenticate: Loading src/SOL005/NSFaultManagement/definitions/SOL005NSFaultManagement_def.yaml +3 −4 Viewed Changes for src/SOL005/NSFaultManagement/definitions/SOL005NSFaultManagement_def.yaml: 3 added lines, 4 removed lines. Original line number Diff line number Diff line Loading @@ -304,10 +304,9 @@ definitions: format: url authentication: description: > Authentication parameters to configure the use of Authorization when sending notifications corresponding to this subscription. This attribute shall only be present if the subscriber requires authorization of notifications. Authentication parameters to configure the use of Authorization when sending notifications corresponding to this subscription, as defined in clause 4.5.3.4.8.3.4 of ETSI GS NFV SOL 013. This attribute shall only be present if the subscriber requires authorization of notifications. $ref: "../../definitions/SOL005_def.yaml#/definitions/SubscriptionAuthentication" PerceivedSeverityType: Loading Loading
src/SOL005/NSDManagement/definitions/SOL005NSDescriptorManagement_def.yaml +6 −1 Viewed Changes for src/SOL005/NSDManagement/definitions/SOL005NSDescriptorManagement_def.yaml: 6 added lines, 1 removed line. Original line number Diff line number Diff line Loading @@ -98,7 +98,7 @@ definitions: onboardingFailureDetails: description: > Failure details of current on boarding procedure. See clause 4.3.5.3 for the details of "ProblemDetails" clause 6.3 of ETSI GS NFV-SOL 013 for the details of "ProblemDetails" structure. It shall be present when the "nsdOnboardingState" attribute is CREATED and the uploading or Loading Loading @@ -207,6 +207,7 @@ definitions: onboardingFailureDetails: description: > Failure details of current on-boarding procedure. See clause 6.3 of ETSI GS NFV-SOL 013 for the details of "ProblemDetails" structure. It shall be present when the pnfdOnboardingState attribute is CREATED and the uploading or processing fails in the NFVO. Loading Loading @@ -257,6 +258,10 @@ definitions: description: > The URI of the endpoint to send the notification to. authentication: description: > Authentication parameters to configure the use of Authorization when sending notifications corresponding to this subscription, as defined in clause 8.3.4 of ETSI GS NFV-SOL 013. This attribute shall only be present if the subscriber requires authorization of notifications. $ref: "../../definitions/SOL005_def.yaml#/definitions/SubscriptionAuthentication" description: > This type represents a subscription request related to notifications Loading
src/SOL005/NSDManagement/NSDManagement.yaml +261 −176 Viewed Changes for src/SOL005/NSDManagement/NSDManagement.yaml: 261 added lines, 176 removed lines. Original line number Diff line number Diff line Loading @@ -17,8 +17,8 @@ info: name: "NFV-SOL WG" externalDocs: description: ETSI GS NFV-SOL 005 V2.5.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.05.01_60/gs_NFV-SOL005v020501p.pdf description: ETSI GS NFV-SOL 005 V2.6.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.06.01_60/gs_NFV-SOL005v020601p.pdf basePath: /nsd/v1 Loading Loading @@ -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: > Loading Loading @@ -90,11 +90,14 @@ paths: description: > 201 CREATED An NS descriptor resource was 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: Loading Loading @@ -134,21 +137,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" 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 required: false type: string description: > Attribute-based filtering expression according to clause 4.3.2. Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013. The NFVO shall support receiving this filtering parameter as part of the URI query string. The OSS/BSS may supply this parameter. All attribute names that appear in the NsdInfo and in data types referenced from it shall Loading @@ -158,28 +160,29 @@ paths: required: false type: string description: > Include all complex attributes in the response. See clause 4.3.3 for details. Include all complex attributes in the response. See clause 5.3 of ETSI GS NFV SOL 013 for details. The NFVO shall support this parameter. - name: fields in: query required: false type: string description: > Complex attributes to be included into the response. See clause 4.3.3 for Complex attributes to be included into the response. See clause 5.3 of ETSI GS NFV SOL 013 for details. The NFVO should support this parameter. - name: exclude_fields in: query required: false type: string description: > Complex attributes to be excluded from the response. See clause 4.3.3 for Complex attributes to be excluded from the response. See clause 5.3 of ETSI GS NFV SOL 013 for details. The NFVO should support this parameter. - name: exclude_default in: query required: false type: string description: > Indicates to exclude the following complex attributes from the response. See clause 4.3.3 for details. Indicates to exclude the following complex attributes from the response. See clause 5.3 of ETSI GS NFV SOL 013 for details. The VNFM shall support this parameter. The following attributes shall be excluded from the NsdInfo structure in the response body if this parameter is provided, or none of the parameters "all_fields," "fields", "exclude_fields", "exclude_default" Loading @@ -188,7 +191,8 @@ paths: in: query description: > Marker to obtain the next page of a paged response. Shall be supported by the NFVO if the NFVO supports alternative 2 (paging) according to clause 4.7.2.1 for this resource. if the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource. required: false type: string - name: Accept Loading @@ -204,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. Loading Loading @@ -254,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 # Loading Loading @@ -285,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: > Loading @@ -302,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: Loading Loading @@ -342,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 Loading @@ -375,7 +385,7 @@ paths: description: > 200 OK The operation was completed successfully. The operation has been completed successfully. The response body shall contain attribute modifications for an 'Individual NS Descriptor' resource (see clause 5.5.2.6). headers: Loading Loading @@ -416,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: Loading @@ -428,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. Loading Loading @@ -488,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 # Loading Loading @@ -528,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: > Loading @@ -568,15 +587,16 @@ paths: description: > 200 OK On success, the content of the NSD is returned. 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. Loading @@ -601,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" Loading @@ -618,48 +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 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: > Loading @@ -677,13 +714,16 @@ paths: description: > 202 ACCEPTED The NSD content was 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. Loading @@ -708,7 +748,8 @@ paths: description: > 204 NO CONTENT The NSD content was successfully uploaded and validated (synchronous mode). The NSD content successfully uploaded and validated (synchronous mode). The response body shall be empty. headers: WWW-Authenticate: Loading Loading @@ -741,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 # Loading Loading @@ -802,13 +849,14 @@ paths: description: > 201 CREATED A PNF descriptor resource was 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: Loading Loading @@ -848,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. Loading @@ -860,7 +910,7 @@ paths: required: false type: string description: > Attribute-based filtering expression according to clause 4.3.2. Attribute-based filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013. The NFVO shall support receiving this filtering parameter as part of the URI query string. The OSS/BSS may supply this parameter. All attribute names that appear in the PnfdInfo and in data types Loading @@ -870,21 +920,21 @@ paths: required: false type: string description: > Include all complex attributes in the response. See clause 4.3.3 for details. Include all complex attributes in the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFVO shall support this parameter. - name: fields in: query required: false type: string description: > Complex attributes to be included into the response. See clause 4.3.3 for Complex attributes to be included into the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFVO should support this parameter. - name: exclude_fields in: query required: false type: string description: > Complex attributes to be excluded from the response. See clause 4.3.3 for Complex attributes to be excluded from the response. See clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFVO should support this parameter. - name: exclude_default in: query Loading @@ -892,7 +942,7 @@ paths: type: string description: > Indicates to exclude the following complex attributes from the response. See clause 4.3.3 for details. The NFVO shall support this parameter. clause 5.3 of ETSI GS NFV-SOL 013 for details. The NFVO shall support this parameter. The following attributes shall be excluded from the PnfdInfo structure in the response body if this parameter is provided, or none of the parameters "all_fields," "fields", "exclude_fields", "exclude_default" are provided: Loading @@ -903,16 +953,22 @@ paths: required: false description: > Marker to obtain the next page of a paged response. Shall be supported by the NFVO if the NFVO supports alternative 2 (paging) according to clause 4.7.2.1 for this resource. if the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource. responses: 200: description: > 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.2 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. Loading Loading @@ -965,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 # Loading @@ -983,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 Loading Loading @@ -1015,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. Loading Loading @@ -1054,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. Loading Loading @@ -1087,8 +1145,9 @@ paths: description: > 200 OK The operation was completed successfully. The response body shall contain attribute modifications for an 'Individual PNF Descriptor' The operation has been completed successfully. 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" Loading Loading @@ -1131,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. Loading @@ -1138,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: > Loading Loading @@ -1180,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 # Loading Loading @@ -1228,9 +1290,12 @@ paths: description: > 200 OK On success, the content of the PNFD is returned. 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. Loading Loading @@ -1267,15 +1332,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 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. Loading @@ -1297,7 +1368,7 @@ paths: description: > 204 NO CONTENT The PNFD content was successfully uploaded and validated. The PNFD content successfully uploaded and validated. The response body shall be empty. headers: WWW-Authenticate: Loading Loading @@ -1330,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" Loading Loading @@ -1364,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: > Loading Loading @@ -1407,10 +1474,13 @@ paths: description: > 201 CREATED The subscription was 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: Loading Loading @@ -1438,10 +1508,13 @@ paths: 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. 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: Loading @@ -1460,25 +1533,21 @@ 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 required: false type: string description: > Attribute filtering expression according to clause 4.3.2. Attribute filtering expression according to clause 5.2 of ETSI GS NFV-SOL 013. The NFVO shall support receiving this parameter as part of the URI query string. The OSS/BSS may supply this parameter. All attribute names that appear in the NsdmSubscription and in data types referenced Loading @@ -1489,7 +1558,8 @@ paths: type: string description: > Marker to obtain the next page of a paged response. Shall be supported by the NFVO if the NFVO supports alternative 2 (paging) according to clause 4.7.2.1 for this resource. if the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of ETSI GS NFV-SOL 013 for this resource. - name: Accept description: > Content-Types that are acceptable for the response. Loading @@ -1502,10 +1572,19 @@ paths: description: > 200 OK The list of subscriptions was queried successfully. The response body shall contain the representations of all active subscriptions of the functional block that invokes the method. 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. Loading Loading @@ -1559,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 # Loading Loading @@ -1652,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 Loading Loading @@ -1683,7 +1766,7 @@ paths: description: > 204 NO CONTENT The subscription resource was deleted successfully. The subscription resource has been deleted successfully. The response body shall be empty. headers: WWW-Authenticate: Loading Loading @@ -1716,3 +1799,5 @@ paths: $ref: "../responses/SOL005_resp.yaml#/responses/500" 503: $ref: "../responses/SOL005_resp.yaml#/responses/503" 504: $ref: "../responses/SOL005_resp.yaml#/responses/504" No newline at end of file
src/SOL005/NSDManagementNotification/definitions/SOL005NSDescriptorManagementNotification_def.yaml +6 −0 Viewed Changes for src/SOL005/NSDManagementNotification/definitions/SOL005NSDescriptorManagementNotification_def.yaml: 6 added lines, 0 removed lines. Original line number Diff line number Diff line Loading @@ -67,6 +67,9 @@ definitions: nsdId: $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" onboardingFailureDetails: description: > Failure details of current onboarding procedure. See clause 6.3 of ETSI GS NFV-SOL 013 for the details of "ProblemDetails" structure. $ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails" _links: $ref: "#/definitions/NsdmLinks" Loading Loading @@ -222,6 +225,9 @@ definitions: pnfdId: $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" onboardingFailureDetails: description: > Failure details of current onboarding procedure. See clause 6.3 of ETSI GS NFV-SOL 013 for the details of "ProblemDetails" structure. $ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails" _links: $ref: "#/definitions/PnfdmLinks" Loading
src/SOL005/NSDManagementNotification/NSDManagementNotification.yaml +16 −16 Viewed Changes for src/SOL005/NSDManagementNotification/NSDManagementNotification.yaml: 16 added lines, 16 removed lines. Original line number Diff line number Diff line Loading @@ -14,8 +14,8 @@ info: url: https://forge.etsi.org/etsi-forge-copyright-notice.txt externalDocs: description: ETSI GS NFV-SOL 005 V2.5.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.05.01_60/gs_NFV-SOL005v020501p.pdf description: ETSI GS NFV-SOL 005 V2.6.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/02.06.01_60/gs_NFV-SOL005v020601p.pdf basePath: /callback/v1 Loading Loading @@ -86,7 +86,7 @@ paths: description: > 204 NO CONTENT The notification was delivered successfully. Shall be returned when the notification has been delivered successfully. headers: WWW-Authenticate: type: string Loading Loading @@ -143,7 +143,7 @@ paths: description: > 204 NO CONTENT The notification endpoint was tested successfully. Shall be returned when the notification endpoint has been tested successfully. The response body shall be empty. headers: WWW-Authenticate: Loading Loading @@ -234,7 +234,7 @@ paths: description: > 204 NO CONTENT The notification was delivered successfully. Shall be returned when the notification has been delivered successfully. headers: WWW-Authenticate: type: string Loading Loading @@ -291,7 +291,7 @@ paths: description: > 204 NO CONTENT The notification endpoint was tested successfully. Shall be returned when the notification endpoint has been tested successfully. The response body shall be empty. headers: WWW-Authenticate: Loading Loading @@ -382,7 +382,7 @@ paths: description: > 204 NO CONTENT The notification was delivered successfully. Shall be returned when the notification has been delivered successfully. headers: WWW-Authenticate: type: string Loading Loading @@ -439,7 +439,7 @@ paths: description: > 204 NO CONTENT The notification endpoint was tested successfully. Shall be returned when the notification endpoint has been tested successfully. The response body shall be empty. headers: WWW-Authenticate: Loading Loading @@ -530,7 +530,7 @@ paths: description: > 204 NO CONTENT The notification was delivered successfully. Shall be returned when the notification has been delivered successfully. headers: WWW-Authenticate: type: string Loading Loading @@ -587,7 +587,7 @@ paths: description: > 204 NO CONTENT The notification endpoint was tested successfully. Shall be returned when the notification endpoint has been tested successfully. The response body shall be empty. headers: WWW-Authenticate: Loading Loading @@ -678,7 +678,7 @@ paths: description: > 204 NO CONTENT The notification was delivered successfully. Shall be returned when the notification has been delivered successfully. headers: WWW-Authenticate: type: string Loading Loading @@ -735,7 +735,7 @@ paths: description: > 204 NO CONTENT The notification endpoint was tested successfully. Shall be returned when the notification endpoint has been tested successfully. The response body shall be empty. headers: WWW-Authenticate: Loading Loading @@ -826,7 +826,7 @@ paths: description: > 204 NO CONTENT The notification was delivered successfully. Shall be returned when the notification has been delivered successfully. headers: WWW-Authenticate: type: string Loading Loading @@ -883,7 +883,7 @@ paths: description: > 204 NO CONTENT The notification endpoint was tested successfully. Shall be returned when the notification endpoint has been tested successfully. The response body shall be empty. headers: WWW-Authenticate: Loading Loading @@ -974,7 +974,7 @@ paths: description: > 204 NO CONTENT The notification was delivered successfully. Shall be returned when the notification has been delivered successfully. headers: WWW-Authenticate: type: string Loading Loading @@ -1031,7 +1031,7 @@ paths: description: > 204 NO CONTENT The notification endpoint was tested successfully. Shall be returned when the notification endpoint has been tested successfully. The response body shall be empty. headers: WWW-Authenticate: Loading
src/SOL005/NSFaultManagement/definitions/SOL005NSFaultManagement_def.yaml +3 −4 Viewed Changes for src/SOL005/NSFaultManagement/definitions/SOL005NSFaultManagement_def.yaml: 3 added lines, 4 removed lines. Original line number Diff line number Diff line Loading @@ -304,10 +304,9 @@ definitions: format: url authentication: description: > Authentication parameters to configure the use of Authorization when sending notifications corresponding to this subscription. This attribute shall only be present if the subscriber requires authorization of notifications. Authentication parameters to configure the use of Authorization when sending notifications corresponding to this subscription, as defined in clause 4.5.3.4.8.3.4 of ETSI GS NFV SOL 013. This attribute shall only be present if the subscriber requires authorization of notifications. $ref: "../../definitions/SOL005_def.yaml#/definitions/SubscriptionAuthentication" PerceivedSeverityType: Loading