From 1f88700925fdcedf114ac763c1abcd512e6fe018 Mon Sep 17 00:00:00 2001 From: rameshnaraya Date: Fri, 7 Dec 2018 15:08:24 +0100 Subject: [PATCH] Merge Request Issue. Re committing NSD Files. --- src/SOL005/NSDManagement/NSDManagement.yaml | 991 +++++++++++++----- .../SOL005NSDescriptorManagement_def.yaml | 593 ++++++----- .../NSDManagement/definitions/SOL005_def.yaml | 34 +- .../NSDescriptorManagement_resp.yaml | 85 +- .../NSDManagement/responses/SOL005_resp.yaml | 12 +- 5 files changed, 1176 insertions(+), 539 deletions(-) diff --git a/src/SOL005/NSDManagement/NSDManagement.yaml b/src/SOL005/NSDManagement/NSDManagement.yaml index 330293d..4e8df5d 100644 --- a/src/SOL005/NSDManagement/NSDManagement.yaml +++ b/src/SOL005/NSDManagement/NSDManagement.yaml @@ -2,13 +2,13 @@ swagger: "2.0" info: description: > - "DRAFT - SOL005 - NSD Management Interface IMPORTANT: Please note that + "SOL005 - NSD Management Interface IMPORTANT: Please note that this file might be not aligned to the current version of the ETSI Group Specification it refers to and has not been approved by the ETSI NFV ISG. In case of discrepancies the published ETSI Group Specification takes precedence. Please report bugs to https://forge.etsi.org/bugzilla/buglist.cgi?component=Nfv-Openapis" version: "2.4.1" - title: "DRAFT - SOL005 - NSD Management Interface" + title: "SOL005 - NSD Management Interface" contact: name: "NFV-SOL WG" license: @@ -100,22 +100,30 @@ paths: responses: 200: description: > - "Information about zero or more NS descriptors. + 200 OK. + + Information about zero or more NS descriptors. The response body shall contain a representation of zero or more NS descriptors, as defined in - clause 5.5.2.2" - schema: - $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo" + clause 5.5.2.2 headers: Content-Type: - type: string description: The MIME type of the body of the response. + type: string + maximum: 1 + minimum: 1 WWW-Authenticate: type: string 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. + request has provided an invalid authorization token. + schema: + type: array + items: + properties: + NsdInfo: + $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo" 400: $ref: "responses/SOL005_resp.yaml#/responses/400" 401: @@ -141,19 +149,8 @@ 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 - resource. This method shall follow the provisions specified in the - Tables 5.4.2.3.1-1 and 5.4.2.3.1-2 for URI query parameters, - request and response data structures, and response codes." - parameters: - - name: "createNsdInfoRequest" - description: > - "The CreateNsdInfoRequest contains parameters for creating - an NS descriptor resource, as defined in clause 5.5.2.4 of GS NFV-SOL 005." - in: "body" - required: true - schema: - $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/CreateNsdInfoRequest" + The POST method is used to create a new NS descriptor resource or a new version of an on-boarded NS descriptor. + parameters: - name: Accept description: > Content-Types that are acceptable for the response. @@ -174,20 +171,56 @@ paths: Reference: IETF RFC 7231 in: header required: true - type: string + type: string + - name: "body" + in: "body" + required: true + schema: + type: "object" + required: + - "CreateNsdInfoRequest" + properties: + CreateNsdInfoRequest: + $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/CreateNsdInfoRequest" + description: > + The CreateNsdInfoRequest contains parameters for creating + an NS descriptor resource, as defined in clause 5.5.2.4 of GS NFV-SOL 005. responses: 201: - description: > - Status 201 + description: "Status 201" + schema: + type: "object" + 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 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 of + GS NFV-SOL 005. + The HTTP response shall include a "Location" + HTTP header that contains the resource URI of the + new NS descriptor resource. + properties: + NsdInfo: + $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo" + headers: + Location: + type: "string" + description: > + The HTTP response shall include a Location HTTP header + that contains the resource URI of the new NS descriptor resource. + Content-Type: + type: "string" + description: > + The MIME type of the body of the response.This header + field shall be present if the response has a non-empty message + body. + WWW-Authenticate: + type: "string" + 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. 400: $ref: "responses/SOL005_resp.yaml#/responses/400" 401: @@ -209,23 +242,8 @@ paths: 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: - $ref: "responses/SOL005_resp.yaml#/responses/503" - schema: - type: "object" - description: > - "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 of - GS NFV-SOL 005." - properties: - NsdInfo: - $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo" - headers: - Location: - type: "string" - description: > - "The HTTP response shall include a "Location" HTTP header - that contains the resource URI of the new NS descriptor resource." + $ref: "responses/SOL005_resp.yaml#/responses/503" + ############################################################################### # Individual NS Descriptor # ############################################################################### @@ -254,71 +272,36 @@ paths: type: string responses: 200: - description: > - 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. + description: "Status 201" schema: - $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo" - 400: - $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" - 401: - $ref: "responses/SOL005_resp.yaml#/responses/401" - 403: - $ref: "responses/SOL005_resp.yaml#/responses/403" - 404: - $ref: "responses/SOL005_resp.yaml#/responses/404" - 405: - $ref: "responses/SOL005_resp.yaml#/responses/405" - 406: - $ref: "responses/SOL005_resp.yaml#/responses/406" - 409: - $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409" - 412: - $ref: "responses/SOL005_resp.yaml#/responses/412" - 416: - $ref: "responses/SOL005_resp.yaml#/responses/416" - 500: - $ref: "responses/SOL005_resp.yaml#/responses/500" - 503: - $ref: "responses/SOL005_resp.yaml#/responses/503" - delete: - summary: "Delete an individual NS descriptor resource." - description: > - "The DELETE method deletes an individual NS descriptor resource. - An individual NS descriptor resource can only be deleted when there is no - NS instance using it (i.e. usageState = NOT_IN_USE) and has been disabled - already (i.e. operationalState = DISABLED). Otherwise, the DELETE method - shall fail. This method shall follow the provisions specified in the Tables - 5.4.3.3.5-1 and 5.4.3.3.5-2 of GS NFV-SOL 005 for URI query parameters, - request and response data structures, and response codes." - parameters: - - name: Authorization - description: > - The authorization token for the request. - Reference: IETF RFC 7235 - in: header - required: false - type: string - responses: - 204: - description: > - 204 No Content - - The operation has completed successfully. - The response body shall be empty. + type: "object" + description: > + 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. + properties: + NsdInfo: + $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo" headers: + Location: + type: "string" + description: > + The HTTP response shall include a Location HTTP header + that contains the resource URI of the new NS descriptor resource. + Content-Type: + type: "string" + description: > + The MIME type of the body of the response.This header + field shall be present if the response has a non-empty message body. WWW-Authenticate: + type: "string" 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 + authorization, or error details if the corresponding HTTP request + has provided an invalid authorization token. 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 401: @@ -334,17 +317,17 @@ paths: 409: $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409" 412: - $ref: "responses/SOL005_resp.yaml#/responses/412" + $ref: "responses/SOL005_resp.yaml#/responses/412" 416: $ref: "responses/SOL005_resp.yaml#/responses/416" 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: - $ref: "responses/SOL005_resp.yaml#/responses/503" + $ref: "responses/SOL005_resp.yaml#/responses/503" patch: - summary: "Update NSD Info" + 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 + 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. @@ -353,11 +336,8 @@ paths: 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. 3) Modify the user defined data of an individual NS descriptor resource. - This method shall follow the provisions specified in the Tables 5.4.3.3.4-1 - and 5.4.3.3.4-2 for URI query parameters,request and response data structures, - and response codes." parameters: - - name: "NsdInfoModifications" + - name: "body" in: "body" required: true schema: @@ -368,9 +348,7 @@ paths: NsdInfoModifications: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfoModifications" description: > - "The operation was completed successfully. The response body - shall contain attribute modifications for an 'Individual NS Descriptor' - resource (see clause 5.5.2.6 of GS NFV SOL-005)." + Parameters for the modification of an individual NS descriptor resource. - name: Authorization description: > The authorization token for the request. @@ -388,10 +366,11 @@ paths: responses: 200: description: > - 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. + 200 OK. + The operation was completed successfully. + The response body shall contain attribute + modifications for an 'Individual NS Descriptor' + resource. headers: Content-Type: description: The MIME type of the body of the response. @@ -409,7 +388,63 @@ paths: schema: type: array items: - $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfoModifications" + properties: + NsdInfoModifications: + $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfoModifications" + 400: + $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" + 401: + $ref: "responses/SOL005_resp.yaml#/responses/401" + 403: + $ref: "responses/SOL005_resp.yaml#/responses/403" + 404: + $ref: "responses/SOL005_resp.yaml#/responses/404" + 405: + $ref: "responses/SOL005_resp.yaml#/responses/405" + 406: + $ref: "responses/SOL005_resp.yaml#/responses/406" + 409: + $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409" + 412: + $ref: "responses/SOL005_resp.yaml#/responses/412" + 416: + $ref: "responses/SOL005_resp.yaml#/responses/416" + 500: + $ref: "responses/SOL005_resp.yaml#/responses/500" + 503: + $ref: "responses/SOL005_resp.yaml#/responses/503" + + delete: + summary: "Delete an individual NS descriptor resource." + description: > + The DELETE method deletes an individual NS descriptor resource. + An individual NS descriptor resource can only be deleted when there is no NS instance using it (i.e. usageState = + NOT_IN_USE) and has been disabled already (i.e. operationalState = DISABLED). Otherwise, the DELETE method + shall fail. + parameters: + - name: Authorization + description: > + The authorization token for the request. + Reference: IETF RFC 7235 + in: header + required: false + type: string + responses: + 204: + description: > + 204 No Content + + The operation has completed successfully. + 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 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 401: @@ -440,6 +475,7 @@ paths: in: "path" required: true type: "string" + ############################################################################### # NSD Content # ############################################################################### @@ -447,9 +483,9 @@ paths: get: 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 + 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 @@ -461,7 +497,7 @@ paths: "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." + of the NSD zip file is outside the scope of the present document. parameters: - name: Accept description: > @@ -493,12 +529,16 @@ paths: responses: 200: description: > - "On success, the content of the NSD is returned. 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. 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." + OK. + On success, the content of the NSD is returned. + 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. + 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. headers: Content-Type: description: The MIME type of the body of the response. @@ -513,7 +553,6 @@ paths: type: string maximum: 1 minimum: 0 - 206: $ref: "responses/SOL005_resp.yaml#/responses/206" 400: @@ -529,7 +568,7 @@ paths: 406: $ref: "responses/SOL005_resp.yaml#/responses/406" 409: - $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409" + $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409-nsd-onboarding-state-NOT-ONBOARDED" 412: $ref: "responses/SOL005_resp.yaml#/responses/412" 416: @@ -544,21 +583,26 @@ paths: 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" + 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 + 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." parameters: - name: Accept description: > Content-Types that are acceptable for the response. + The payload body contains a copy of the file representing the NSD + or a ZIP file that contains the file or multiple files representing the NSD. in: header required: true type: string @@ -575,7 +619,7 @@ paths: responses: 202: description: > - "Status 202" + 202 Accepted headers: Content-Type: description: The MIME type of the body of the response. @@ -592,8 +636,10 @@ paths: minimum: 0 204: description: > - "The NSD content was successfully uploaded and validated (synchronous - mode). The response body shall be empty." + 204 No Content + + The NSD content was successfully uploaded and validated (synchronous mode). + The response body shall be empty. 206: $ref: "responses/SOL005_resp.yaml#/responses/206" 400: @@ -609,7 +655,7 @@ paths: 406: $ref: "responses/SOL005_resp.yaml#/responses/406" 409: - $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409" + $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409-nsd-onboarding-state-NOT-ONBOARDED" 412: $ref: "responses/SOL005_resp.yaml#/responses/412" 416: @@ -624,6 +670,7 @@ paths: in: "path" required: true type: "string" + ############################################################################### # PNF Descriptors # ############################################################################### @@ -700,9 +747,11 @@ paths: maximum: 1 minimum: 0 schema: - type: array + type: "array" items: - $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfo" + properties: + PnfdInfo: + $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfo" 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 401: @@ -728,15 +777,8 @@ paths: post: summary: "Create a new PNF descriptor resource." description: > - "The POST method is used to create a new PNF descriptor resource." + The POST method is used to create a new PNF descriptor resource parameters: - - name: "CreatePnfdInfoRequest" - description: > - "Parameters of creating a PNF descriptor resource, as defined in clause 5.5.2.6." - in: "body" - required: true - schema: - $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/CreatePnfdInfoRequest" - name: Accept description: > Content-Types that are acceptable for the response. @@ -758,32 +800,52 @@ paths: in: header required: true type: string - responses: + - name: "body" + in: "body" + required: true + schema: + type: "object" + required: + - "CreatePnfdInfoRequest" + properties: + CreatePnfdInfoRequest: + $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/CreatePnfdInfoRequest" + description: > + Parameters of creating a PNF descriptor resource. + responses: 201: - description: > - Status 201 - - A PNF descriptor resource was 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. + description: 201 Created. + schema: + type: "object" + description: > + A PNF descriptor resource was created successfully, + as a new PNF descriptor resource. + The response body shall contain a representation 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 + properties: + PnfdInfo: + $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfo" headers: + Location: + type: "string" + description: > + The HTTP response shall include a Location HTTP header + that contains the resource URI of the new NS descriptor resource. Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 + type: "string" + description: > + The MIME type of the body of the response.This header + field shall be present if the response has a non-empty message + body. WWW-Authenticate: + type: "string" 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 - schema: - $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfo" + authorization, or error details if the corresponding HTTP request + has provided an invalid authorization token. 206: $ref: "responses/SOL005_resp.yaml#/responses/206" 400: @@ -815,18 +877,34 @@ paths: get: summary: "Read an individual PNFD resource." description: > - "The GET method reads information about an individual PNF descriptor. + 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." + response data structures, and response codes. + parameters: + - name: "Accept" + in: "header" + required: true + type: "string" + description: > + Content-Types that are acceptable for the response. This header + field shall be present if the response is expected to have a non-empty + message body. + - name: "Authorization" + in: "header" + required: false + type: "string" + description: > + The authorization token for the request. Details are specified + in clause 4.5.3 of GS NFV-SOL 005. responses: 200: description: > - Information about the individual PNFD descriptor. + 200 OK + Information about the individual PNFD descriptor. The response body shall contain a representation of - the individual PNF descriptor, as defined in - clause 5.5.2.5. + the individual PNF descriptor. headers: Content-Type: description: The MIME type of the body of the response. @@ -842,7 +920,10 @@ paths: maximum: 1 minimum: 0 schema: - $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfo" + type: "object" + properties: + PnfdInfo: + $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfo" 400: $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" 401: @@ -868,16 +949,12 @@ paths: delete: summary: "Delete an individual PNF descriptor resource." description: > - "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. This method shall follow the provisions specified - in the Tables 5.4.6.3.5-1 and 5.4.6.3.5-2 of GS NFV-SOL 005 for URI query - parameters, request and response data structures, and response codes." + 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. responses: 204: description: > @@ -912,42 +989,69 @@ paths: patch: summary: "Modify the user defined data of an individual PNF descriptor resource." description: > - "The PATCH method modifies the user defined data of an individual - PNF descriptor resource. This method shall follow the provisions specified - in the Tables 5.4.6.3.4-1 and 5.4.6.3.4-2 for URI query parameters, request - and response data structures, and response codes." + The PATCH method modifies the user defined data of an individual PNF descriptor resource. parameters: + + - name: "Accept" + in: "header" + required: true + type: "string" + description: > + Content-Types that are acceptable for the response. This header + field shall be present if the response is expected to have a non-empty + message body. + - name: "Content-Type" + in: "header" + required: true + type: "string" + description: > + The MIME type of the body of the request. This header field + shall be present if the request has a non-empty message body. + - name: "Authorization" + in: "header" + required: false + type: "string" + description: > + The authorization token for the request. Details are specified in clause 4.5.3. - name: "body" in: "body" required: true schema: - $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfoModifications" + type: "object" + required: + - "PnfdInfoModifications" + properties: + PnfdInfoModifications: + $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfoModifications" + description: > + The PATCH method modifies the user defined data of an individual PNF descriptor resource. responses: 200: - description: > - 200 OK - - The operation was completed successfully. - - The response body shall contain attribute - modifications for an 'Individual PNF Descriptor' - resource (see clause 5.5.2.4). + description: > + 200 OK. + schema: + type: "object" + properties: + PnfdInfoModifications: + $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfoModifications" headers: + Location: + type: "string" + description: > + The HTTP response shall include a Location HTTP header + that contains the resource URI of the new NS descriptor resource. Content-Type: - description: The MIME type of the body of the response. - type: string - maximum: 1 - minimum: 1 + type: "string" + description: > + The MIME type of the body of the response.This header + field shall be present if the response has a non-empty message + body. WWW-Authenticate: + type: "string" 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 - schema: - $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfoModifications" + authorization, or error details if the corresponding HTTP request + has provided an invalid authorization token. 206: $ref: "responses/SOL005_resp.yaml#/responses/206" 400: @@ -971,7 +1075,8 @@ paths: 500: $ref: "responses/SOL005_resp.yaml#/responses/500" 503: - $ref: "responses/SOL005_resp.yaml#/responses/503" + $ref: "responses/SOL005_resp.yaml#/responses/503" + parameters: - name: "pnfdInfoId" description: > @@ -986,7 +1091,9 @@ paths: get: summary: "Fetch the content of a PNFD." description: > - "The GET method fetches the content of the PNFD." + The GET method fetches the content of the PNFD. + This resource represents the content of the individual PNF descriptor, i.e. PNFD content. + The client can use this resource to upload and download the content of the PNFD. parameters: - name: Accept description: > @@ -1006,7 +1113,7 @@ paths: responses: 200: description: > - 200 OK + 200 OK. On success, the content of the PNFD is returned. The payload body shall contain a copy of the file representing the PNFD. @@ -1026,14 +1133,7 @@ paths: 406: $ref: "responses/SOL005_resp.yaml#/responses/406" 409: - description: > - 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/NSDescriptorManagement_resp.yaml#/responses/409-pnfd-onboarding-state-NOT-ONBOARDED" 412: $ref: "responses/SOL005_resp.yaml#/responses/412" 416: @@ -1045,10 +1145,9 @@ paths: put: summary: "Upload the content of a PNFD." description: > - "The PUT method is used to upload the content of a PNFD. This method - shall follow the provisions specified in the Tables 5.4.7.3.3-1 and 5.4.7.3.3-2 - of GS NFV-SOL 005for URI query parameters, request and response data structures, - and response codes." + The PUT method is used to upload the content of a PNFD. + This resource represents the content of the individual PNF descriptor, i.e. PNFD content. + The client can use this resource to upload and download the content of the PNFD. parameters: - name: Accept description: > @@ -1068,7 +1167,7 @@ paths: responses: 204: description: > - 204 No Content + 204 No Content. The PNFD content was successfully uploaded and validated. The response body shall be empty. @@ -1087,17 +1186,7 @@ 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 - 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/NSDescriptorManagement_resp.yaml#/responses/409-pnfd-onboarding-state-NOT-CREATED" 412: $ref: "responses/SOL005_resp.yaml#/responses/412" 416: @@ -1120,11 +1209,14 @@ paths: get: summary: "Query multiple subscriptions." description: > - "The GET method queries the list of active subscriptions of the + 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, as specified in - the Tables 5.4.8.3.2-1 and 5.4.8.3.2-2 of GS NFV-SOL 005." + 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. parameters: - name: "filter" in: "query" @@ -1152,7 +1244,9 @@ paths: type: string responses: 200: - description: > + 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 @@ -1163,10 +1257,6 @@ paths: type: string maximum: 1 minimum: 1 - Location: - description: The resource URI of the created NS instance - type: string - format: url WWW-Authenticate: description: > Challenge if the corresponding HTTP request has not provided @@ -1174,17 +1264,16 @@ paths: request has provided an invalid authorization token. type: string maximum: 1 - minimum: 0 + minimum: 0 schema: type: "array" - description: > - "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." - items: - $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscription" + items: + properties: + NsdmSubscription: + $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscription" 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. @@ -1220,8 +1309,8 @@ paths: post: 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, + 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 @@ -1232,25 +1321,104 @@ paths: 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: + callbackUri). + + This resource represents subscriptions. + The client can use this resource to subscribe to notifications related to NSD + management and to query its subscriptions. + parameters: + - name: Accept + description: > + Content-Types that are acceptable for the response. + Reference: IETF RFC 7231 + in: header + required: true + type: string + - name: Authorization + description: > + The authorization token for the request. + Reference: IETF RFC 7235 + in: header + required: false + type: string + - name: Content-Type + description: > + The MIME type of the body of the request. + Reference: IETF RFC 7231 + in: header + required: true + type: string - name: "body" in: "body" required: true schema: - $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscriptionRequest" + type: "object" + required: + - "NsdmSubscriptionRequest" + properties: + NsdmSubscriptionRequest: + $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscriptionRequest" + description: > + Parameters of creating a new NS Description request. responses: 201: - description: > - "Status 201" + description: > + 201 Created. + + The subscription was 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. schema: - $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscription" + type: "object" + properties: + NsdmSubscription: + $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscription" headers: Location: type: "string" - description: > - "The HTTP response shall include a "Location:"HTTP - header that points to the created subscription resource." + description: > + The HTTP response shall include a Location HTTP header + that contains the resource URI of the new NS descriptor resource. + Content-Type: + type: "string" + description: > + The MIME type of the body of the response.This header + field shall be present if the response has a non-empty message + body. + WWW-Authenticate: + type: "string" + 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. + 206: + $ref: "responses/SOL005_resp.yaml#/responses/206" + 400: + $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" + 401: + $ref: "responses/SOL005_resp.yaml#/responses/401" + 403: + $ref: "responses/SOL005_resp.yaml#/responses/403" + 404: + $ref: "responses/SOL005_resp.yaml#/responses/404" + 405: + $ref: "responses/SOL005_resp.yaml#/responses/405" + 406: + $ref: "responses/SOL005_resp.yaml#/responses/406" + 409: + $ref: "responses/NSDescriptorManagement_resp.yaml#/responses/409" + 412: + $ref: "responses/SOL005_resp.yaml#/responses/412" + 416: + $ref: "responses/SOL005_resp.yaml#/responses/416" + 500: + $ref: "responses/SOL005_resp.yaml#/responses/500" + 503: + $ref: "responses/SOL005_resp.yaml#/responses/503" + + + ############################################################################### # Individual Subscription # ############################################################################### @@ -1258,32 +1426,279 @@ paths: get: summary: "Read an individual subscription resource." description: > - "The GET method retrieves information about a subscription by reading - an individual subscription resource. This method shall support the URI query - parameters, request and response data structures, and response codes, as - specified in the Tables 5.4.9.3.2-1 and 5.4.9.3.2-2." - parameters: [] + The GET method retrieves information about a subscription by reading + an individual subscription resource. + This resource represents an individual subscription. + It can be used by the client to read and to terminate a subscription to + notifications related to NSD management. + parameters: + - name: "Accept" + in: "header" + required: true + type: "string" + description: > + Content-Types that are acceptable for the response. This header + field shall be present if the response is expected to have a non-empty + message body. + - name: "Authorization" + in: "header" + required: false + type: "string" + description: > + The authorization token for the request. Details are specified + in clause 4.5.3 of GS NFV-SOL 005. + responses: 200: - description: > - "Status 200" + description: > + 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 of GS NFV-SOL 005. schema: $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscription" + headers: + Content-Type: + type: "string" + description: > + The MIME type of the body of the response. This header + field shall be present if the response has a non-empty message body. + WWW-Authenticate: + type: "string" + 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. delete: summary: "Terminate Subscription" description: > - "The DELETE method terminates an individual subscription. This - method shall support the URI query parameters, request and response data - structures, and response codes, as specified in the Tables 5.4.9.3.5-1 and - 5.4.9.3.3-2 of GS NFV-SOL 005." - parameters: [] + The DELETE method terminates an individual subscription. + This resource represents an individual subscription. + It can be used by the client to read and to terminate a subscription to + notifications related to NSD management. + parameters: + - name: "Authorization" + in: "header" + required: false + type: "string" + description: > + The authorization token for the request. + Details are specified in clause 4.5.3 of GS NFV-SOL 005. responses: 204: - description: > - "The subscription resource was deleted successfully. The response - body shall be empty." + description: > + 204 No Content. + The subscription resource was deleted successfully. + The response body shall be empty. parameters: - name: "subscriptionId" + description: Identifier of this subscription. in: "path" required: true - type: "string" \ No newline at end of file + type: "string" + +############################################################################### +# Notification endpoint # +# "/notification_endpoint" is the # +# is the dummy URI used for testing, in real case endpoint URI has to # +# provided by client. # +############################################################################### + '/notification_endpoint': + post: + summary: Notify about NSD and PNFD changes. + description: > + The POST method delivers a notification from the server to the client. + This method shall support the URI query parameters, request and response data structures, and response codes, as + specified in the Tables 6.4.18.3.1-1 and 6.4.18.3.1-2. + + This resource represents a notification endpoint. The server can use this resource to send notifications to a subscribed + client, which has provided the URI of this resource during the subscription process. + + # Don't know how to pass multiple body parameters. + # Jenkin build is failing if enable more than one body parameters, So commented body parameters. + parameters: + - name: NsdOnBoardingNotification + description: > + A notification about the successful on-boarding of an NSD. + in: body + required: true + schema: + properties: + NsdOnBoardingNotification: + $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdOnBoardingNotification" +# - name: NsdOnBoardingFailureNotification +# description: > +# A notification about the failure of on-boarding an NSD. +# in: body +# required: true +# schema: +# properties: +# NsdOnBoardingFailureNotification: +# $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdOnBoardingFailureNotification" +# - name: NsdChangeNotification +# description: > +# A notification about the state change of an on-boarded NSD. +# in: body +# required: true +# schema: +# properties: +# NsdChangeNotification: +# $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdChangeNotification" +# - name: NsdDeletionNotification +# description: > +# A notification about the deletion of an on-boarded NSD. +# in: body +# required: true +# schema: +# properties: +# NsdDeletionNotification: +# $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdDeletionNotification" +# - name: PnfdOnBoardingNotification +# description: > +# A notification about the successful on-boarding of a PNFD. +# in: body +# required: true +# schema: +# properties: +# PnfdOnBoardingNotification: +# $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdOnBoardingNotification" +# - name: PnfdOnBoardingFailureNotification +# description: > +# A notification about the failure of on-boarding a PNFD. +# in: body +# required: true +# schema: +# properties: +# PnfdOnBoardingFailureNotification: +# $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdOnBoardingFailureNotification" +# - name: PnfdDeletionNotification +# description: > +# A notification about the deletion of an on-boarded PNFD. +# in: body +# required: true +# schema: +# properties: +# PnfdDeletionNotification: +# $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdDeletionNotification" + - name: Accept + description: > + Content-Types that are acceptable for the response. + Reference: IETF RFC 7231 + in: header + required: true + type: string + - name: Authorization + description: > + The authorization token for the request. + Reference: IETF RFC 7235 + in: header + required: false + type: string + - name: Content-Type + description: > + The MIME type of the body of the request. + Reference: IETF RFC 7231 + in: header + required: true + type: string + responses: + 204: + description: > + 204 No Content. + The notification was delivered successfully. + headers: + Content-Type: + description: The MIME type of the body of the response. + type: string + maximum: 1 + minimum: 1 + Location: + description: The resource URI of the created NS instance + type: string + format: url + WWW-Authenticate: + description: > + Challenge if the corresponding HTTP request has not provided + authorization, or error details if the corresponding HTTP + request has provided an invalid authorization token. + type: string + maximum: 1 + minimum: 0 + 400: + $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" + 401: + $ref: "responses/SOL005_resp.yaml#/responses/401" + 403: + $ref: "responses/SOL005_resp.yaml#/responses/403" + 404: + $ref: "responses/SOL005_resp.yaml#/responses/404" + 405: + $ref: "responses/SOL005_resp.yaml#/responses/405" + 406: + $ref: "responses/SOL005_resp.yaml#/responses/406" + 409: + $ref: "responses/NSDescriptorManagement_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" + get: + summary: Test the notification endpoint. + description: > + The GET method allows the server to test the notification endpoint that is provided by the client, + e.g. during subscription. + This method shall follow the provisions specified in the Tables 5.4.10.3.2-1 and 5.4.10.3.2-2 for URI query parameters, + request and response data structures, and response codes. + parameters: + - name: Accept + description: > + Content-Types that are acceptable for the response. + Reference: IETF RFC 7231 + in: header + required: true + type: string + - name: Authorization + description: > + The authorization token for the request. + Reference: IETF RFC 7235 + in: header + required: false + type: string + responses: + 204: + description: > + 204 No Content. + The notification endpoint was tested successfully. + The response body shall be empty. + headers: + Content-Type: + description: The MIME type of the body of the response. + type: string + 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 + 400: + $ref: "responses/SOL005_resp.yaml#/responses/400-attr-selector" + 401: + $ref: "responses/SOL005_resp.yaml#/responses/401" + 403: + $ref: "responses/SOL005_resp.yaml#/responses/403" + 404: + $ref: "responses/SOL005_resp.yaml#/responses/404" + 405: + $ref: "responses/SOL005_resp.yaml#/responses/405" + 406: + $ref: "responses/SOL005_resp.yaml#/responses/406" + 409: + $ref: "responses/NSDescriptorManagement_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" \ No newline at end of file diff --git a/src/SOL005/NSDManagement/definitions/SOL005NSDescriptorManagement_def.yaml b/src/SOL005/NSDManagement/definitions/SOL005NSDescriptorManagement_def.yaml index 98911e4..702a0c7 100644 --- a/src/SOL005/NSDManagement/definitions/SOL005NSDescriptorManagement_def.yaml +++ b/src/SOL005/NSDManagement/definitions/SOL005NSDescriptorManagement_def.yaml @@ -1,4 +1,120 @@ definitions: + NsdInfo: + type: "object" + required: + - "id" + - "nsdOnboardingState" + - "nsdOperationalState" + - "nsdUsageState" + - "_links" + properties: + id: + description: > + Identifier of the on boarded individual NS descriptor + resource. This identifier is allocated by the NFVO. + $ref: "SOL005_def.yaml#/definitions/Identifier" + nsdId: + description: > + This identifier, which is allocated by the NSD + designer, identifies the NSD in a globally unique + way. It is copied from the NSD content and shall be + present after the NSD content is on-boarded. + $ref: "SOL005_def.yaml#/definitions/Identifier" + nsdName: + type: "string" + description: > + "Name of the on boarded NSD. This information is copied from the + NSD content and shall be present after the NSD content is on-boarded." + nsdVersion: + description: > + Version of the on-boarded NSD. This information is + copied from the NSD content and shall be present + after the NSD content is on-boarded. + $ref: "SOL005_def.yaml#/definitions/Version" + nsdDesigner: + type: "string" + description: > + "Designer of the on-boarded NSD. This information is copied + from the NSD content and shall be present after the NSD content is on-boarded." + nsdInvariantId: + description: > + This identifier, which is allocated by the NSD + designer, identifies an NSD in a version independent + manner. This information is copied from the NSD + content and shall be present after the NSD content is + on-boarded. + $ref: "SOL005_def.yaml#/definitions/Identifier" + vnfPkgIds: + description: > + Identifies the VNF package for the VNFD referenced + by the on-boarded NS descriptor resource. + type: array + items: + $ref: "SOL005_def.yaml#/definitions/Identifier" + pnfdInfoIds: + description: > + Identifies the PnfdInfo element for the PNFD + referenced by the on-boarded NS descriptor + resource. + type: array + items: + $ref: "SOL005_def.yaml#/definitions/Identifier" + nestedNsdInfoIds: + description: > + Identifies the NsdInfo element for the nested NSD + referenced by the on-boarded NS descriptor + resource. + type: array + items: + $ref: "SOL005_def.yaml#/definitions/Identifier" + nsdOnboardingState: + description: > + On boarding state of the individual NS descriptor resource. + $ref: "#/definitions/NsdOnboardingStateType" + onboardingFailureDetails: + description: > + Failure details of current on boarding procedure. See + clause 4.3.5.3 for the details of "ProblemDetails" + structure. + It shall be present when the "nsdOnboardingState" + attribute is CREATED and the uploading or + processing fails in NFVO. + $ref: "SOL005_def.yaml#/definitions/ProblemDetails" + nsdOperationalState: + description: > + Operational state of the individual NS descriptor + resource. This attribute can be modified with the + PATCH method. + $ref: "#/definitions/NsdOperationalStateType" + nsdUsageState: + description: > + Usage state of the individual NS descriptor resource. + $ref: "#/definitions/NsdUsageStateType" + userDefinedData: + description: > + User defined data for the individual NS descriptor + resource. This attribute can be modified with the + PATCH method. + $ref: "SOL005_def.yaml#/definitions/KeyValuePairs" + _links: + type: "object" + required: + - "self" + - "nsd_content" + description: > + "Links to resources related to this resource." + properties: + self: + description: > + "URI of this resource." + $ref: "SOL005_def.yaml#/definitions/Link" + nsd_content: + description: > + "Link to the NSD content resource" + $ref: "SOL005_def.yaml#/definitions/Link" + description: > + "This type represents a response for the query NSD operation." + NsdInfoModifications: type: "object" description: > @@ -38,21 +154,30 @@ - "_links" properties: id: - $ref: "#/definitions/Identifier" + description: > + Identifier of this subscription resource. + $ref: "SOL005_def.yaml#/definitions/Identifier" filter: + description: > + Filter settings for this subscription, to define the subset + of all notifications this subscription relates to. + A particular notification is sent to the subscriber if the filter + matches, or if there is no filter. $ref: "#/definitions/NsdmNotificationsFilter" callbackUri: - $ref: "#/definitions/Uri" + description: > + The URI of the endpoint to send the notification to. + $ref: "SOL005_def.yaml#/definitions/Uri" _links: type: "object" description: > - "Links to resources related to this resource." + Links to resources related to this resource. properties: self: - $ref: "#/definitions/Link" + $ref: "SOL005_def.yaml#/definitions/Link" description: > - "This type represents a subscription related to notifications about - NSD management." + This type represents a subscription related to notifications about NSD management. + NsdmSubscriptionRequest: type: "object" required: @@ -63,14 +188,12 @@ callbackUri: type: "string" description: > - "The URI of the endpoint to send the notification to." + The URI of the endpoint to send the notification to. authentication: $ref: "#/definitions/SubscriptionAuthentication" description: > - "This type represents a subscription request related to notifications - about NSD management." - Identifier: - type: "object" + This type represents a subscription request related to notifications + about NSD management. NsdmNotificationsFilter: type: "object" description: > @@ -102,23 +225,29 @@ - "PnfdOnBoardingFailureNotification" - "PnfdDeletionNotification" nsdInfoId: + description: > + Match the NsdInfo identifier which is allocated by the NFVO. type: array items: - $ref: "#/definitions/Identifier" + $ref: "SOL005_def.yaml#/definitions/Identifier" nsdId: + description: > + Match the NSD identifier, which is allocated by the NSD designer. type: array items: - $ref: "#/definitions/Identifier" + $ref: "SOL005_def.yaml#/definitions/Identifier" nsdName: description: > - "Match the name of the on boarded NSD." + Match the name of the on boarded NSD. type: array items: $ref: "SOL005_def.yaml#/definitions/String" nsdVersion: + description: > + Match the NSD version listed as part of this attribute. type: array items: - $ref: "#/definitions/Version" + $ref: "SOL005_def.yaml#/definitions/Version" nsdDesigner: description: > "Match the NSD designer of the on-boarded NSD." @@ -126,69 +255,94 @@ items: $ref: "SOL005_def.yaml#/definitions/String" nsdInvariantId: + description: > + Match the NSD invariant identifier which is allocated + by the NSD designer and identifies an NSD in a + version independent manner. type: array items: - $ref: "#/definitions/Identifier" + $ref: "SOL005_def.yaml#/definitions/Identifier" vnfPkgIds: + description: > + Match VNF packages with a package identifier listed + in the attribute. type: array items: - $ref: "#/definitions/Identifier" + $ref: "SOL005_def.yaml#/definitions/Identifier" pnfdInfoIds: + description: > + Match the PnfdInfo identifier for the PNFD + referenced by the on-boarded NSD. type: array items: - $ref: "#/definitions/Identifier" + $ref: "SOL005_def.yaml#/definitions/Identifier" nestedNsdInfoIds: + description: > + Match the NsdInfo identifier for the nested NSD + referenced by the on-boarded NSD. type: array items: - $ref: "#/definitions/Identifier" + $ref: "SOL005_def.yaml#/definitions/Identifier" nsdOnboardingState: + description: > + Match particular on-boarding state of the NSD. type: array items: $ref: "#/definitions/NsdOnboardingStateType" nsdOperationalState: + description: > + Match particular operational state of the on-boarded NSD. type: array items: $ref: "#/definitions/NsdOperationalStateType" nsdUsageState: + description: > + Match particular usage state of the on-boarded NSD. type: array items: $ref: "#/definitions/NsdUsageStateType" pnfdId: + description: > + Match the PNFD identifier which is copied from the PNFD content. type: array items: - $ref: "#/definitions/Identifier" + $ref: "SOL005_def.yaml#/definitions/Identifier" pnfdName: description: > - "Match the name of the on-boarded PNFD." + Match the name of the on-boarded PNFD. type: array items: $ref: "SOL005_def.yaml#/definitions/String" pnfdVersion: + description: > + Match the PNFD designer of the on-boarded PNFD. type: array items: - $ref: "#/definitions/Version" + $ref: "SOL005_def.yaml#/definitions/Version" pnfdProvider: description: > - "Match the provider of the on-boarded PNFD." + Match the provider of the on-boarded PNFD. type: array items: $ref: "SOL005_def.yaml#/definitions/String" pnfdInvariantId: + description: > + Match the PNFD in a version independent manner. type: array items: - $ref: "#/definitions/Identifier" + $ref: "SOL005_def.yaml#/definitions/Identifier" pnfdOnboardingState: + description: > + Match particular on-boarding state of the PNFD. type: array items: $ref: "#/definitions/PnfdOnboardingStateType" pnfdUsageState: + description: > + Match the usage state of the individual PNF descriptor resource. type: array items: $ref: "#/definitions/PnfdUsageStateType" - Uri: - type: "object" - Link: - type: "object" SubscriptionAuthentication: description: > The procedure defined in clause 4.5.2 allows an API consumer to @@ -230,7 +384,54 @@ enum: - BASIC - OAUTH2_CLIENT_CREDENTIALS - - TLS_CERT + - TLS_CERT + paramsBasic: + type: "object" + description: > + Parameters for authentication/authorization using BASIC. + Shall be present if authType is "BASIC" and + the contained information has not been + provisioned out of band. Shall be absent otherwise. + properties: + userName: + description: > + Username to be used in HTTP Basic authentication. + Shall be present if it has not been provisioned out of band. + type: string + password: + description: > + Password to be used in HTTP Basic authentication. + Shall be present if it has not been provisioned out of band. + type: string + paramsOauth2ClientCredentials: + type: "object" + description: > + Parameters for authentication/authorization using OAUTH2_CLIENT_CREDENTIALS. + Shall be present if authType is "OAUTH2_CLIENT_CREDENTIALS" and the + contained information has not been provisioned out of band. + Shall be absent otherwise + properties: + clientId: + description: > + Client identifier to be used in the access token + request of the OAuth 2.0 client credentials + grant type. Shall be present if it has not been + provisioned out of band. + type: string + clientPassword: + description: > + Client password to be used in the access + token request of the OAuth 2.0 client + credentials grant type. Shall be present if it + has not been provisioned out of band. + type: string + tokenEndpoint: + description: > + The token endpoint from which the access + token can be obtained. Shall be present if it + has not been provisioned out of band. + $ref: "SOL005_def.yaml#/definitions/Uri" + NsdOperationalStateType: type: "string" description: > @@ -242,137 +443,21 @@ enum: - "ENABLED" - "DISABLED" - NsdInfo: - type: "object" - required: - - "id" - - "nsdOnboardingState" - - "nsdOperationalState" - - "nsdUsageState" - - "_links" - properties: - id: - description: > - Identifier of the on boarded individual NS descriptor - resource. This identifier is allocated by the NFVO. - $ref: "#/definitions/Identifier" - nsdId: - description: > - This identifier, which is allocated by the NSD - designer, identifies the NSD in a globally unique - way. It is copied from the NSD content and shall be - present after the NSD content is on-boarded. - $ref: "#/definitions/Identifier" - nsdName: - type: "string" - description: > - "Name of the on boarded NSD. This information is copied from the - NSD content and shall be present after the NSD content is on-boarded." - nsdVersion: - description: > - Version of the on-boarded NSD. This information is - copied from the NSD content and shall be present - after the NSD content is on-boarded. - $ref: "#/definitions/Version" - nsdDesigner: - type: "string" - description: > - "Designer of the on-boarded NSD. This information is copied - from the NSD content and shall be present after the NSD content is on-boarded." - nsdInvariantId: - description: > - This identifier, which is allocated by the NSD - designer, identifies an NSD in a version independent - manner. This information is copied from the NSD - content and shall be present after the NSD content is - on-boarded. - $ref: "#/definitions/Identifier" - vnfPkgIds: - description: > - Identifies the VNF package for the VNFD referenced - by the on-boarded NS descriptor resource. See - note 1. - type: array - items: - $ref: "#/definitions/Identifier" - pnfdInfoIds: - description: > - Identifies the PnfdInfo element for the PNFD - referenced by the on-boarded NS descriptor - resource. - type: array - items: - $ref: "#/definitions/Identifier" - nestedNsdInfoIds: - description: > - Identifies the NsdInfo element for the nested NSD - referenced by the on-boarded NS descriptor - resource. - type: array - items: - $ref: "#/definitions/Identifier" - nsdOnboardingState: - description: > - On boarding state of the individual NS descriptor resource. - $ref: "#/definitions/NsdOnboardingStateType" - onboardingFailureDetails: - description: > - Failure details of current on boarding procedure. See - clause 4.3.5.3 for the details of "ProblemDetails" - structure. - It shall be present when the "nsdOnboardingState" - attribute is CREATED and the uploading or - processing fails in NFVO. - $ref: "#/definitions/ProblemDetails" - nsdOperationalState: - description: > - Operational state of the individual NS descriptor - resource. This attribute can be modified with the - PATCH method. - $ref: "#/definitions/NsdOperationalStateType" - nsdUsageState: - description: > - Usage state of the individual NS descriptor resource. - $ref: "#/definitions/NsdUsageStateType" - userDefinedData: - description: > - User defined data for the individual NS descriptor - resource. This attribute can be modified with the - PATCH method. - $ref: "SOL005_def.yaml#/definitions/KeyValuePairs" - _links: - type: "object" - description: > - "Links to resources related to this resource." - properties: - self: - description: > - "URI of this resource." - $ref: "#/definitions/Link" - nsd_content: - description: > - "Link to the NSD content resource" - $ref: "#/definitions/Link" - description: > - "This type represents a response for the query NSD operation." - Version: - type: "object" NsdOnboardingStateType: type: "string" description: > "The enumeration NsdOnboardingStateType shall comply with the provisions defined in Table 5.5.4.5-1 of GS NFV-SOL 005. It indicates the on-boarding - state of the NSD.CREATED = The NSD information object is created. UPLOADING - = The associated NSD content is being uploaded. PROCESSING = The associated - NSD content is being processed, e.g. validation. ONBOARDED = The associated - NSD content is on-boarded." + state of the NSD. + CREATED = The NSD information object is created. + UPLOADING = The associated NSD content is being uploaded. + PROCESSING = The associated NSD content is being processed, e.g. validation. + ONBOARDED = The associated NSD content is on-boarded." enum: - "CREATED" - "UPLOADING" - "PROCESSING" - "ONBOARDED" - ProblemDetails: - type: "object" NsdUsageStateType: type: "string" description: > @@ -405,40 +490,65 @@ PnfdInfo: type: "object" required: - - "_links" - "id" - "pnfdOnboardingState" - "pnfdUsageState" + - "_links" properties: id: - $ref: "#/definitions/Identifier" + description: > + Identifier of the on-boarded individual PNF + descriptor resource. This identifier is allocated by + the NFVO. + $ref: "SOL005_def.yaml#/definitions/Identifier" pnfdId: - $ref: "#/definitions/Identifier" + description: > + This identifier, which is managed by the PNFD + designer, identifies the PNFD in a globally unique way. + It is copied from the PNFD content and shall + be present after the PNFD content is on-boarded. + $ref: "SOL005_def.yaml#/definitions/Identifier" pnfdName: - type: "string" description: > - "Name of the onboarded PNFD. This information is copied from - the PNFD content and shall be present after the PNFD content is on-boarded." - pnfdVersion: - $ref: "#/definitions/Version" + Name of the on-boarded PNFD. This information + is copied from the PNFD content and shall be + present after the PNFD content is on-boarded. + type: "string" + pnfdersion: + $ref: "SOL005_def.yaml#/definitions/Version" pnfdProvider: - type: "string" description: > - "Provider of the onboarded PNFD. This information is copied from - the PNFD content and shall be present after the PNFD content is onboarded." + "Provider of the on-boarded PNFD. This information is copied from + the PNFD content and shall be present after the PNFD content is on-boarded." + type: "string" pnfdInvariantId: - $ref: "#/definitions/Identifier" + description: > + Identifies a PNFD in a version independent + manner. This attribute is invariant across versions + of PNFD. + $ref: "SOL005_def.yaml#/definitions/Identifier" pnfdOnboardingState: + description: > + On-boarding state of the individual PNF descriptor resource. $ref: "#/definitions/PnfdOnboardingStateType" onboardingFailureDetails: - $ref: "#/definitions/ProblemDetails" + description: > + Failure details of current on-boarding procedure. + It shall be present when the + pnfdOnboardingState attribute is CREATED + and the uploading or processing fails in the NFVO. + $ref: "SOL005_def.yaml#/definitions/ProblemDetails" pnfdUsageState: + description: > + Usage state of the individual PNF descriptor resource. $ref: "#/definitions/PnfdUsageStateType" userDefinedData: - type: "object" + type: "array" description: > - "User defined data for the individual PNF descriptor resource. - This attribute can be modified with the PATCH method." + User defined data for the individual PNF descriptor resource. + This attribute can be modified with the PATCH method. + items: + type: "object" _links: required: - "pnfd_content" @@ -448,20 +558,22 @@ "Links to resources related to this resource." properties: self: - $ref: "#/definitions/Link" + $ref: "SOL005_def.yaml#/definitions/Link" pnfd_content: - $ref: "#/definitions/Link" + $ref: "SOL005_def.yaml#/definitions/Link" description: > "This type represents a response for the query PNFD operation." + PnfdOnboardingStateType: type: "string" description: > - "The enumeration PnfdOnboardingStateType shall comply with the provisions - defined in Table 5.5.4.6-1 of GS-NFV SOL005. It indicates the onboarding state - of the individual PNF descriptor resource.CREATED = The PNF descriptor - resource is created. UPLOADING = The associated PNFD content is being uploaded. + The enumeration PnfdOnboardingStateType shall comply with the provisions + defined in Table 5.5.4.6-1 of GS-NFV SOL005. It indicates the on-boarding state + of the individual PNF descriptor resource. + CREATED = The PNF descriptor resource is created. + UPLOADING = The associated PNFD content is being uploaded. PROCESSING = The associated PNFD content is being processed, e.g. validation. - ONBOARDED = The associated PNFD content is on-boarded." + ONBOARDED = The associated PNFD content is on-boarded. enum: - "CREATED" - "UPLOADING" @@ -483,7 +595,9 @@ userDefinedData: $ref: "SOL005_def.yaml#/definitions/KeyValuePairs" description: > - "This type creates a new PNF descriptor resource." + User-defined data for the PNF descriptor resource to be created. + It shall be present when the user defined data is set for + the individual PNF descriptor resource to be created. NsdmLinks: type: "object" required: @@ -491,13 +605,26 @@ - "subscription" properties: nsdInfo: - $ref: "#/definitions/Link" + $ref: "SOL005_def.yaml#/definitions/Link" subscription: - $ref: "#/definitions/Link" + $ref: "SOL005_def.yaml#/definitions/Link" description: > "This type represents the links to resources that an NSD management notification can contain." - NsdOnboardingNotification: + PnfdmLinks: + type: "object" + required: + - "pnfdInfo" + - "subscription" + properties: + pnfdInfo: + $ref: "SOL005_def.yaml#/definitions/Link" + subscription: + $ref: "SOL005_def.yaml#/definitions/Link" + description: > + "This type represents the links to resources that a PNFD management + notification can contain." + NsdOnBoardingNotification: type: "object" required: - "_links" @@ -508,23 +635,22 @@ - "timeStamp" properties: id: - $ref: "#/definitions/Identifier" + $ref: "SOL005_def.yaml#/definitions/Identifier" notificationType: type: "string" description: > "Discriminator for the different notification types. Shall be set to "NsdOnboardingNotification" for this notification type." subscriptionId: - $ref: "#/definitions/Identifier" + $ref: "SOL005_def.yaml#/definitions/Identifier" timeStamp: - type: "string" - format: "date-time" description: > - "Date-time of the generation of the notification." + Date-time of the generation of the notification. + $ref: "SOL005_def.yaml#/definitions/DateTime" nsdInfoId: - $ref: "#/definitions/Identifier" + $ref: "SOL005_def.yaml#/definitions/Identifier" nsdId: - $ref: "#/definitions/Identifier" + $ref: "SOL005_def.yaml#/definitions/Identifier" _links: $ref: "#/definitions/NsdmLinks" description: > @@ -533,7 +659,7 @@ the provisions defined in Table 5.5.2.9-1. The support of this notification is mandatory. The notification shall be triggered by the NFVO when the " nsdOnboardingState" attribute of a new NSD has changed to "ONBOARDED"." - NsdOnboardingFailureNotification: + NsdOnBoardingFailureNotification: type: "object" required: - "_links" @@ -544,25 +670,24 @@ - "timeStamp" properties: id: - $ref: "#/definitions/Identifier" + $ref: "SOL005_def.yaml#/definitions/Identifier" notificationType: type: "string" description: > "Discriminator for the different notification types. Shall be set to "NsdOnboardingFailureNotification" for this notification type." subscriptionId: - $ref: "#/definitions/Identifier" + $ref: "SOL005_def.yaml#/definitions/Identifier" timeStamp: - type: "string" - format: "date-time" description: > - "Date-time of the generation of the notification." + Date-time of the generation of the notification. + $ref: "SOL005_def.yaml#/definitions/DateTime" nsdInfoId: - $ref: "#/definitions/Identifier" + $ref: "SOL005_def.yaml#/definitions/Identifier" nsdId: - $ref: "#/definitions/Identifier" + $ref: "SOL005_def.yaml#/definitions/Identifier" onboardingFailureDetails: - $ref: "#/definitions/ProblemDetails" + $ref: "SOL005_def.yaml#/definitions/ProblemDetails" _links: $ref: "#/definitions/NsdmLinks" description: > @@ -583,23 +708,22 @@ - "timeStamp" properties: id: - $ref: "#/definitions/Identifier" + $ref: "SOL005_def.yaml#/definitions/Identifier" notificationType: type: "string" description: > "Discriminator for the different notification types. Shall be set to "NsdChangeNotification" for this notification type." subscriptionId: - $ref: "#/definitions/Identifier" + $ref: "SOL005_def.yaml#/definitions/Identifier" timeStamp: - type: "string" - format: "date-time" description: > - "Date-time of the generation of the notification." + Date-time of the generation of the notification. + $ref: "SOL005_def.yaml#/definitions/DateTime" nsdInfoId: - $ref: "#/definitions/Identifier" + $ref: "SOL005_def.yaml#/definitions/Identifier" nsdId: - $ref: "#/definitions/Identifier" + $ref: "SOL005_def.yaml#/definitions/Identifier" nsdOperationalState: $ref: "#/definitions/NsdOperationalStateType" _links: @@ -624,23 +748,22 @@ - "timeStamp" properties: id: - $ref: "#/definitions/Identifier" + $ref: "SOL005_def.yaml#/definitions/Identifier" notificationType: type: "string" description: > "Discriminator for the different notification types. Shall be set to "NsdDeletionNotification " for this notification type." subscriptionId: - $ref: "#/definitions/Identifier" + $ref: "SOL005_def.yaml#/definitions/Identifier" timeStamp: - type: "string" - format: "date-time" description: > - "Date-time of the generation of the notification." + Date-time of the generation of the notification. + $ref: "SOL005_def.yaml#/definitions/DateTime" nsdInfoId: - $ref: "#/definitions/Identifier" + $ref: "SOL005_def.yaml#/definitions/Identifier" nsdId: - $ref: "#/definitions/Identifier" + $ref: "SOL005_def.yaml#/definitions/Identifier" _links: $ref: "#/definitions/NsdmLinks" description: > @@ -649,20 +772,7 @@ comply with the provisions defined in Table 5.5.2.12-1. The support of this notification is mandatory. The notification shall be triggered by the NFVO when it has deleted an on-boarded NSD." - PnfdmLinks: - type: "object" - required: - - "pnfdInfo" - - "subscription" - properties: - pnfdInfo: - $ref: "#/definitions/Link" - subscription: - $ref: "#/definitions/Link" - description: > - "This type represents the links to resources that a PNFD management - notification can contain." - PnfdOnboardingNotification: + PnfdOnBoardingNotification: type: "object" required: - "_links" @@ -673,23 +783,22 @@ - "timeStamp" properties: id: - $ref: "#/definitions/Identifier" + $ref: "SOL005_def.yaml#/definitions/Identifier" notificationType: type: "string" description: > "Discriminator for the different notification types. Shall be set to "PnfdOnboardingNotification" for this notification type." subscriptionId: - $ref: "#/definitions/Identifier" + $ref: "SOL005_def.yaml#/definitions/Identifier" timeStamp: - type: "string" - format: "date-time" description: > - "Date-time of the generation of the notification." + Date-time of the generation of the notification. + $ref: "SOL005_def.yaml#/definitions/DateTime" pnfdInfoId: - $ref: "#/definitions/Identifier" + $ref: "SOL005_def.yaml#/definitions/Identifier" pnfdId: - $ref: "#/definitions/Identifier" + $ref: "SOL005_def.yaml#/definitions/Identifier" _links: $ref: "#/definitions/PnfdmLinks" description: > @@ -697,7 +806,7 @@ the receiver of the successful on-boarding of aPNFD. It shall comply with the provisions defined in Table 5.5.2.13-1. The support of this notification is mandatory. The notification is triggered when a new PNFD is on-boarded." - PnfdOnboardingFailureNotification: + PnfdOnBoardingFailureNotification: type: "object" required: - "_links" @@ -708,25 +817,24 @@ - "timeStamp" properties: id: - $ref: "#/definitions/Identifier" + $ref: "SOL005_def.yaml#/definitions/Identifier" notificationType: type: "string" description: > "Discriminator for the different notification types. Shall be set to "PnfdOnboardingFailureNotification" for this notification type." subscriptionId: - $ref: "#/definitions/Identifier" + $ref: "SOL005_def.yaml#/definitions/Identifier" timeStamp: - type: "string" - format: "date-time" description: > - "Date-time of the generation of the notification." + Date-time of the generation of the notification. + $ref: "SOL005_def.yaml#/definitions/DateTime" pnfdInfoId: - $ref: "#/definitions/Identifier" + $ref: "SOL005_def.yaml#/definitions/Identifier" pnfdId: - $ref: "#/definitions/Identifier" + $ref: "SOL005_def.yaml#/definitions/Identifier" onboardingFailureDetails: - $ref: "#/definitions/ProblemDetails" + $ref: "SOL005_def.yaml#/definitions/ProblemDetails" _links: $ref: "#/definitions/PnfdmLinks" description: > @@ -757,16 +865,15 @@ "Discriminator for the different notification types. Shall be set to "PnfdDeletionNotification " for this notification type." subscriptionId: - $ref: "#/definitions/Identifier" + $ref: "SOL005_def.yaml#/definitions/Identifier" timeStamp: - type: "string" - format: "date-time" description: > - "Date-time of the generation of the notification." + Date-time of the generation of the notification. + $ref: "SOL005_def.yaml#/definitions/DateTime" pnfdInfoId: - $ref: "#/definitions/Identifier" + $ref: "SOL005_def.yaml#/definitions/Identifier" pnfdId: - $ref: "#/definitions/Identifier" + $ref: "SOL005_def.yaml#/definitions/Identifier" _links: $ref: "#/definitions/PnfdmLinks" description: > diff --git a/src/SOL005/NSDManagement/definitions/SOL005_def.yaml b/src/SOL005/NSDManagement/definitions/SOL005_def.yaml index 8434465..efc9b17 100644 --- a/src/SOL005/NSDManagement/definitions/SOL005_def.yaml +++ b/src/SOL005/NSDManagement/definitions/SOL005_def.yaml @@ -1,6 +1,10 @@ # 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. + type: string KeyValuePairs: description: > This type represents a list of key-value pairs. The order of the pairs in the list is not significant. @@ -10,7 +14,35 @@ String: description: > This type represents stack of string values - type: string + type: string + + Version: + description: > + A Version. + type: string + + Uri: + description: > + String formatted according to IETF RFC 3986. + type: string + Link: + description: > + This type represents a link to a resource. + type: object + required: + - href + properties: + href: + description: > + URI of the referenced resource. + type: string + format: url + DateTime: + description: > + Date-time stamp. + Representation: String formatted according to IETF RFC 3339. + type: string + format: "date-time" ProblemDetails: #SOL005 location: 4.3.5.3-1 description: > diff --git a/src/SOL005/NSDManagement/responses/NSDescriptorManagement_resp.yaml b/src/SOL005/NSDManagement/responses/NSDescriptorManagement_resp.yaml index 8e24e31..97eaac7 100644 --- a/src/SOL005/NSDManagement/responses/NSDescriptorManagement_resp.yaml +++ b/src/SOL005/NSDManagement/responses/NSDescriptorManagement_resp.yaml @@ -56,7 +56,7 @@ description: > Conflict - The operation cannot be executed currently, + 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. @@ -112,7 +112,7 @@ description: > Conflict - Another request is in progress that prohibits the fulfilment of + Another request is in progress that prohibits the fulfillment of the current request, or the current resource state is inconsistent with the request. headers: @@ -207,5 +207,86 @@ type: string maximum: 1 minimum: 0 + schema: + $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" + 409-nsd-onboarding-state-NOT-ONBOARDED: + description: > + 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. + headers: + Content-Type: + description: The MIME type of the body of the response. + type: string + maximum: 1 + minimum: 1 + 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 + schema: + $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" + 409-pnfd-onboarding-state-NOT-ONBOARDED: + description: > + 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. + headers: + Content-Type: + description: The MIME type of the body of the response. + type: string + maximum: 1 + minimum: 1 + 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 + schema: + $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" + 409-pnfd-onboarding-state-NOT-CREATED: + description: > + 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. + headers: + Content-Type: + description: The MIME type of the body of the response. + type: string + maximum: 1 + minimum: 1 + 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 schema: $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" \ No newline at end of file diff --git a/src/SOL005/NSDManagement/responses/SOL005_resp.yaml b/src/SOL005/NSDManagement/responses/SOL005_resp.yaml index f3ddbc0..63de4a6 100644 --- a/src/SOL005/NSDManagement/responses/SOL005_resp.yaml +++ b/src/SOL005/NSDManagement/responses/SOL005_resp.yaml @@ -49,7 +49,7 @@ minimum: 0 206: description: > - Partial Content + Partial Content. On success, if the NFVO supports range requests, a single consecutive byte range from the content of the @@ -332,10 +332,13 @@ $ref: "../definitions/SOL005_def.yaml#/definitions/ProblemDetails" 412: description: > - Precondition Failed + Precondition Failed. A precondition given in an HTTP request header is not fulfilled. + Typically, this is due to an ETag mismatch, indicating that the - resource was modified by another entity. The response body should + resource was modified by another entity. + + The response body should contain a ProblemDetails structure, in which the "detail" attribute should convey more information about the error. headers: @@ -349,8 +352,7 @@ 416: description: > 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"). + match any available byte range in the NSD file (e.g. access after end of file). The response body may contain a ProblemDetails structure. headers: Content-Type: -- GitLab