diff --git a/Readme.md b/Readme.md index 79f29dce4579a17188cc0dd23e8a00a7e85816d6..9144ea2a3b23dd7720f664309d8c6e1838a8b039 100644 --- a/Readme.md +++ b/Readme.md @@ -1,7 +1,7 @@ # NFV SOL005 APIs This repository hosts the [OpenAPI](https://www.openapis.org/) specificatons and other documentation -for the APIs defined in ETSI NFV GSs SOL005 v3.6.1. +for the APIs defined in ETSI NFV GSs SOL005 v4.4.1. The APIs described in this repository are defined for the `Os-Ma-nfvo` reference point. diff --git a/src/SOL005/APIVersion/APIVersion.yaml b/src/SOL005/APIVersion/APIVersion.yaml index bec77fe1070f37c35112864e5b3b5a97730348f6..2dc88b22ae28c811244b6ad571cd1bb19b0e3f12 100644 --- a/src/SOL005/APIVersion/APIVersion.yaml +++ b/src/SOL005/APIVersion/APIVersion.yaml @@ -19,8 +19,8 @@ info: version: 1.10.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 005 V4.3.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/04.03.01_60/gs_NFV-SOL005v040301p.pdf + description: ETSI GS NFV-SOL 005 V4.4.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/04.04.01_60/gs_NFV-SOL005v040401p.pdf servers: - url: http://127.0.0.1/ diff --git a/src/SOL005/NFVICapacityInformation/NFVICapacityInformation.yaml b/src/SOL005/NFVICapacityInformation/NFVICapacityInformation.yaml index 02364421f3d2bec2e31b2de442d5067c7d7e3fb5..26729a4245f4869f1e4db44bd8b246bfa3db7807 100644 --- a/src/SOL005/NFVICapacityInformation/NFVICapacityInformation.yaml +++ b/src/SOL005/NFVICapacityInformation/NFVICapacityInformation.yaml @@ -16,11 +16,11 @@ info: license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt - version: 1.10.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 + version: 1.11.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 005 V4.3.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/04.03.01_60/gs_NFV-SOL005v040301p.pdf + description: ETSI GS NFV-SOL 005 V4.4.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/04.04.01_60/gs_NFV-SOL005v040401p.pdf servers: - url: http://127.0.0.1/nfvici/v1 @@ -315,7 +315,7 @@ components: description: | Identifier of the VIM with associated NFVI capacity information. This identifier can be retrieved from the "vimId" attribute in the CapacityShortageNotification. - It can also be retrieved from the "vimId" attribute in the payload body of the response. + It can also be retrieved from the "vimId" attribute in the message content of the response. required: true style: simple explode: false @@ -329,7 +329,7 @@ components: Identifier of the capacity threshold. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new "Individual capacity threshold" resource. It can also be retrieved from the "id" - attribute in the payload body of that response. + attribute in the message content of that response. required: true style: simple explode: false @@ -498,11 +498,11 @@ components: CapacityThresholds.Post.422: description: | - 422 UNPROCESSABLE ENTITY + 422 Unprocessable Content - Shall be returned upon the following error: The content type of the payload body is supported and the payload - body of a request contains syntactically correct data but the data cannot be processed. - The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013 [16], + Shall be returned upon the following error: The content type of the message content is supported and the + message content of a request contains syntactically correct data but the data cannot be processed. + The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013, including rules for the presence of the response body. Specifically in case of this resource, the response code 422 shall also be returned if the NFVO has tested the Notification endpoint as described in clause 10.4.6.3.2 and the test has failed. @@ -656,11 +656,11 @@ components: IndividualCapacityThreshold.Patch.422: description: | - 422 UNPROCESSABLE ENTITY + 422 Unprocessable Content - content type of the payload body is supported and the payload body of a request contains syntactically + content type of the message content is supported and the message content of a request contains syntactically correct data but the data cannot be processed. - The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013 [16], + The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013, including rules for the presence of the response body. Specifically in case of this resource, the response code 422 shall also be returned if the NFVO has tested the Notification endpoint as described in clause 10.4.6.3.2 and the test has failed. diff --git a/src/SOL005/NFVICapacityInformation/definitions/NFVICapacityInformation_def.yaml b/src/SOL005/NFVICapacityInformation/definitions/NFVICapacityInformation_def.yaml index 01e053cac8e33651382ccdd493e81972a735f5e8..60b526add8f8e0b47faf60463374cecda447fc9c 100644 --- a/src/SOL005/NFVICapacityInformation/definitions/NFVICapacityInformation_def.yaml +++ b/src/SOL005/NFVICapacityInformation/definitions/NFVICapacityInformation_def.yaml @@ -227,7 +227,7 @@ components: type: object description: | This type defines the format of a time interval. The type shall comply with the provisions defined in table 10.5.2.7-1. - NOTE: When only the startTime is present, there is no time interval being defined, and therefore the provided timing + NOTE: When only the aTime is present, there is no time interval being defined, and therefore the provided timing information refers to a specific point in time. required: - aTime diff --git a/src/SOL005/NFVICapacityInformationNotification/NFVICapacityInformationNotification.yaml b/src/SOL005/NFVICapacityInformationNotification/NFVICapacityInformationNotification.yaml index 98dd7afb2bdff41be9fbec773a38c71724347b39..da48d84dcb4f795d31c6fad347bc4b99f38fbdd2 100644 --- a/src/SOL005/NFVICapacityInformationNotification/NFVICapacityInformationNotification.yaml +++ b/src/SOL005/NFVICapacityInformationNotification/NFVICapacityInformationNotification.yaml @@ -16,11 +16,11 @@ info: license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt - version: 1.10.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 + version: 1.11.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 005 V4.3.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/04.03.01_60/gs_NFV-SOL005v040301p.pdf + description: ETSI GS NFV-SOL 005 V4.4.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/04.04.01_60/gs_NFV-SOL005v040401p.pdf servers: - url: http://127.0.0.1/callback/v1 diff --git a/src/SOL005/NSDManagement/NSDManagement.yaml b/src/SOL005/NSDManagement/NSDManagement.yaml index acd9e978486085acbdf5661c5bf875c11074cbfe..e6e411443266526b09af6176010af374a5ed34e9 100644 --- a/src/SOL005/NSDManagement/NSDManagement.yaml +++ b/src/SOL005/NSDManagement/NSDManagement.yaml @@ -16,11 +16,11 @@ info: license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt - version: 2.10.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 + version: 2.11.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 005 V4.3.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/04.03.01_60/gs_NFV-SOL005v040301p.pdf + description: ETSI GS NFV-SOL 005 V4.4.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/04.04.01_60/gs_NFV-SOL005v040401p.pdf servers: - url: http://127.0.0.1/nsd/v2 @@ -1077,7 +1077,7 @@ components: ContentTypeZip: name: Content-Type description: | - The payload body contains a ZIP file that represents the NSD archive, as specified above. + The message content contains a ZIP file that represents the NSD archive, as specified above. The request shall set the "Content-Type" HTTP header to "application/zip". in: header required: true @@ -1168,7 +1168,7 @@ components: Identifier of this subscription. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new subscription resource. It can also be retrieved - from the "id" attribute in the payload body of that response. + from the "id" attribute in the message content of that response. required: true style: simple explode: false @@ -1542,7 +1542,7 @@ components: 200 OK Shall be returned when the content of the NSD has been read successfully. - The payload body shall contain a copy of the ZIP file that contains the NSD file structure. + The message content shall contain a copy of the ZIP file that contains the NSD file structure. The "Content-Type" HTTP header shall be set to "application/zip". headers: Content-Type: @@ -1576,7 +1576,7 @@ components: shall be returned when a single consecutive byte range from the content of the NSD file has been read successfully according to the request. The response body shall contain the requested part of the NSD archive. - The "Content-Range" HTTP header shall be provided according to IETF RFC 7233 [10]. + 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. headers: Content-Type: @@ -1808,7 +1808,7 @@ components: 200 OK 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 + The message content 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 @@ -1906,12 +1906,12 @@ components: If the "include_signatures" URI query parameter was absent in the request, or if the manifest file has all security-related information embedded (i.e. there is no separate - certificate file), the payload body shall contain a copy of the manifest file of the + certificate file), the message content shall contain a copy of the manifest file of the NSD archive, and the "Content-Type" HTTP header shall be set to "text/plain". If the "include_signatures" URI query parameter was present in the related request and the manifest file does not have all the security-related information embedded (i.e. there is a separate certificate file), the "Content-Type" HTTP header shall be set to "application/zip" - and the payload body shall contain a ZIP archive which includes: + and the message content shall contain a ZIP archive which includes: - a copy of the manifest file of the NSD archive; - a copy of the related individual certificate file. headers: @@ -1982,7 +1982,7 @@ components: Shall be returned when the content of the artifact file has been read successfully. If the "include_signatures" request URI parameter was not provided in the related request, - the payload body shall contain a copy of the artifact file from the NSD archive, as defined + the message content shall contain a copy of the artifact file from the NSD archive, as defined by ETSI GS NFV-SOL 007, and the "Content-Type" HTTP header shall be set according to the content type of the artifact file. If the artifact is encrypted, the header shall be set to the value "application/cms" (IETF RFC 7193). @@ -1990,7 +1990,7 @@ components: If the content type cannot be determined, the header shall be set to the value "application/octet-stream". If the "include_signatures" request URI parameter was provided in the related request, the "Content-Type" HTTP header shall be set to "application/zip" - and the payload body shall contain a ZIP archive which includes: + and the message content shall contain a ZIP archive which includes: - a copy of the artifact file from the VNF package, as defined by ETSI GS NFVSOL 007 - the related security information (individual signature file and optional related individual certificate file). @@ -2373,7 +2373,7 @@ components: Shall be returned when the content of the PNFD archive has been read successfully. - The payload body shall contain a copy of the PNFD archive + The message content shall contain a copy of the PNFD archive The "Content-Type" HTTP header shall be set to "application/zip". headers: Content-Type: @@ -2596,7 +2596,7 @@ components: 200 OK Shall be returned when the content of the PNFD has been read successfully. - The payload body shall contain a copy of the file representing the PNFD + The pmessage content shall contain a copy of the file representing the PNFD or a ZIP file that contains the file or multiple files representing the PNFD, as specified above. The "Content-Type" HTTP header shall be set according to the format of @@ -2695,14 +2695,14 @@ components: read successfully. If the "include_signatures" URI query parameter was absent in the request, or if the manifest file has all security-related information - embedded (i.e. there is no separate certificate file), the payload - body shall contain a copy of the manifest file of the PNFD archive, + embedded (i.e. there is no separate certificate file), the message + content shall contain a copy of the manifest file of the PNFD archive, and the "Content-Type" HTTP header shall be set to "text/plain". If the "include_signatures" URI query parameter was present in the related request and the manifest file does not have all the security-related information embedded (i.e. there is a separate certificate file), the "Content-Type" HTTP header shall be set to "application/zip" and - the payload body shall contain a ZIP archive which includes: + the message content shall contain a ZIP archive which includes: - a copy of the manifest file of the PNFD archive; - a copy of the related individual certificate file. headers: @@ -2779,7 +2779,7 @@ components: Shall be returned when the content of the artifact file has been read successfully. If the "include_signatures" request URI parameter was not provided in the related request, - the payload body shall contain a copy of the artifact file from the PNFD archive, as defined + the message content shall contain a copy of the artifact file from the PNFD archive, as defined by ETSI GS NFV-SOL 004, and the "Content-Type" HTTP header shall be set according to the content type of the artifact file. If the artifact is encrypted, the header shall be set to the value "application/cms" (IETF RFC 7193). @@ -2787,7 +2787,7 @@ components: If the content type cannot be determined, the header shall be set to the value "application/octetstream". If the "include_signatures" request URI parameter was provided in the related request, the "Content-Type" HTTP header shall be set to "application/zip" - and the payload body shall contain a ZIP archive which includes: + and the message content shall contain a ZIP archive which includes: - a copy of the artifact file from the VNF package, as defined by ETSI GS NFVSOL 004 - the related security information (individual signature file and optional related individual certificate file). @@ -3040,10 +3040,10 @@ components: Subscriptions.Post.422: description: | - 422 Unprocessable Entity + 422 Unprocessable Content - Shall be returned upon the following error: The content type of the payload body is supported and the payload - body of a request contains syntactically correct data but the data cannot be processed. + Shall be returned upon the following error: The content type of the message content is supported and the message + content of a request contains syntactically correct data but the data cannot be processed. The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013 [16], including rules for the presence of the response body. Specifically in case of this resource, the response code 422 shall also be returned if the NFVO has tested diff --git a/src/SOL005/NSDManagementNotification/NSDManagementNotification.yaml b/src/SOL005/NSDManagementNotification/NSDManagementNotification.yaml index 1be7a87596fefb3d977db3066b96658293ef4e34..20c4cf9a5d00fd8359f74d9f3dd89c2146a02fe7 100644 --- a/src/SOL005/NSDManagementNotification/NSDManagementNotification.yaml +++ b/src/SOL005/NSDManagementNotification/NSDManagementNotification.yaml @@ -16,11 +16,11 @@ info: license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt - version: 2.10.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 + version: 2.11.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 005 V4.3.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/04.03.01_60/gs_NFV-SOL005v040301p.pdf + description: ETSI GS NFV-SOL 005 V4.4.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/04.04.01_60/gs_NFV-SOL005v040401p.pdf servers: - url: http://127.0.0.1/callback/v2 diff --git a/src/SOL005/NSFaultManagement/NSFaultManagement.yaml b/src/SOL005/NSFaultManagement/NSFaultManagement.yaml index caf122368c817c1199533a6cdb3a320ae127cbdc..d6424b9a7e73aa5ca27fb041bebf3d593776a0cc 100644 --- a/src/SOL005/NSFaultManagement/NSFaultManagement.yaml +++ b/src/SOL005/NSFaultManagement/NSFaultManagement.yaml @@ -16,11 +16,11 @@ info: license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt - version: 1.10.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 + version: 1.11.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 005 V4.3.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/04.03.01_60/gs_NFV-SOL005v040301p.pdf + description: ETSI GS NFV-SOL 005 V4.4.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/04.04.01_60/gs_NFV-SOL005v040401p.pdf servers: - url: http://127.0.0.1/nsfm/v1 @@ -296,7 +296,7 @@ components: description: | Identifier of the alarm. This identifier can be retrieved from the "id" attribute of the "alarm" attribute in the AlarmNotification or AlarmClearedNotification. It can also be retrieved from the "id" attribute of - the applicable array element in the payload body of the response to a GET request to the "Alarms" resource. + the applicable array element in the message content of the response to a GET request to the "Alarms" resource. required: true style: simple explode: false @@ -309,7 +309,7 @@ components: description: | Identifier of this subscription. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new subscription resource. It can also - be retrieved from the "id" attribute in the payload body of that response. + be retrieved from the "id" attribute in the message content of that response. required: true style: simple explode: false @@ -653,8 +653,8 @@ components: description: | 422 Unprocessable Entity - Shall be returned upon the following error: The content type of the payload body is supported and the payload - body of a request contains syntactically correct data but the data cannot be processed. + Shall be returned upon the following error: The content type of the message content is supported and the + message content of a request contains syntactically correct data but the data cannot be processed. The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013 [16], including rules for the presence of the response body. Specifically in case of this resource, the response code 422 shall also be returned if the NFVO has tested diff --git a/src/SOL005/NSFaultManagement/definitions/SOL005NSFaultManagement_def.yaml b/src/SOL005/NSFaultManagement/definitions/SOL005NSFaultManagement_def.yaml index 3c3e86c0d9751534e273d219f4c5eb9783243162..8d992aa9270f53d701d41924455f0118be39952f 100644 --- a/src/SOL005/NSFaultManagement/definitions/SOL005NSFaultManagement_def.yaml +++ b/src/SOL005/NSFaultManagement/definitions/SOL005NSFaultManagement_def.yaml @@ -20,7 +20,7 @@ definitions: properties: id: description: > - Identifier of this Alarm information element. + Identifier of this Alarm structure. $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" managedObjectId: description: > diff --git a/src/SOL005/NSFaultManagementNotification/NSFaultManagementNotification.yaml b/src/SOL005/NSFaultManagementNotification/NSFaultManagementNotification.yaml index b34accf44f0188a8aa6bed6a166d965498895e27..5b595f49b43f3f08dda4b7c1d97a9a41d080f619 100644 --- a/src/SOL005/NSFaultManagementNotification/NSFaultManagementNotification.yaml +++ b/src/SOL005/NSFaultManagementNotification/NSFaultManagementNotification.yaml @@ -16,11 +16,11 @@ info: license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt - version: 1.10.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 + version: 1.11.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 005 V4.3.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/04.03.01_60/gs_NFV-SOL005v040301p.pdf + description: ETSI GS NFV-SOL 005 V4.4.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/04.04.01_60/gs_NFV-SOL005v040401p.pdf servers: - url: http://127.0.0.1/callback/v1 diff --git a/src/SOL005/NSLCMCoordination/NSLCMCoordination.yaml b/src/SOL005/NSLCMCoordination/NSLCMCoordination.yaml index e34958e4309ff264b465b8170069d28e3970798d..03e7ae5637facfb1d48291f1247ca2bf40f88bbf 100644 --- a/src/SOL005/NSLCMCoordination/NSLCMCoordination.yaml +++ b/src/SOL005/NSLCMCoordination/NSLCMCoordination.yaml @@ -16,11 +16,11 @@ info: license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt - version: 1.10.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 + version: 1.11.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 005 V4.3.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/04.03.01_60/gs_NFV-SOL005v040301p.pdf + description: ETSI GS NFV-SOL 005 V4.4.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/04.04.01_60/gs_NFV-SOL005v040401p.pdf servers: - url: http://127.0.0.1/lcmcoord/v1 @@ -351,7 +351,7 @@ components: Shall be returned when the cancellation request has been accepted for processing. - The response shall have an empty payload body. + The response shall have an empty message content. headers: Version: description: The used API version. diff --git a/src/SOL005/NSLifecycleManagement/NSLifecycleManagement.yaml b/src/SOL005/NSLifecycleManagement/NSLifecycleManagement.yaml index d7f8c989cd243c5f375e69d26c71c0c93490ce19..1c7a7c70fb76826ac9c3be05201597ea2f085bc1 100644 --- a/src/SOL005/NSLifecycleManagement/NSLifecycleManagement.yaml +++ b/src/SOL005/NSLifecycleManagement/NSLifecycleManagement.yaml @@ -16,11 +16,11 @@ info: license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt - version: 2.10.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 + version: 2.11.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 005 V4.3.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/04.03.01_60/gs_NFV-SOL005v040301p.pdf + description: ETSI GS NFV-SOL 005 V4.4.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/04.04.01_60/gs_NFV-SOL005v040401p.pdf servers: - url: http://127.0.0.1/nslcm/v2 @@ -1074,7 +1074,7 @@ components: in: path description: | Identifier of the "Individual VNF snapshot" resource. - This identifier can be retrieved from the "id" attribute in the payload body of a response to a query to + This identifier can be retrieved from the "id" attribute in the message content of a response to a query to "VNF snapshots" resource. required: true style: simple @@ -1139,7 +1139,7 @@ components: NsLcmOpOccCancelRequest: description: | - The POST request to this resource shall include a CancelMode structure in the payload body to choose between + The POST request to this resource shall include a CancelMode structure in the message content to choose between "graceful" and "forceful" cancellation. content: application/json: @@ -1800,7 +1800,7 @@ components: 202 ACCEPTED Shall be returned when the request has been accepted for processing, but processing has not been completed. - The response shall have an empty payload body. + The response shall have an empty message content. headers: Version: description: | @@ -1913,7 +1913,7 @@ components: 202 ACCEPTED Shall be returned when the request has been accepted for processing, but processing has not been completed. - The response shall have an empty payload body. + The response shall have an empty message content. headers: Version: description: | @@ -2026,7 +2026,7 @@ components: 202 ACCEPTED Shall be returned when the request has been accepted for processing, but processing has not been completed. - The response shall have an empty payload body. + The response shall have an empty message content. headers: Version: @@ -2326,7 +2326,7 @@ components: Shall be returned upon the following error: The operation cannot be executed currently, due to a conflict with the state of the NS LCM operation occurrence resource. - Typically, this is due to the fact that the operation occurrence is not in STARTING, PROCESSING or ROLLING_BACK state. + Typically, this is due to the fact that the operation occurrence is not in PROCESSING or ROLLING_BACK state. The response body shall contain a ProblemDetails structure, in which the "detail" attribute shall convey more information about the error. headers: @@ -2468,10 +2468,10 @@ components: NsLcmSubscriptions.Post.422: description: | - 422 Unprocessable Entity + 422 Unprocessable Content - Shall be returned upon the following error: The content type of the payload body is supported and the - payload body of a request contains syntactically correct data but the data cannot be processed. + Shall be returned upon the following error: The content type of the message content is supported and the + message content of a request contains syntactically correct data but the data cannot be processed. The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013 [16], including rules for the presence of the response body. Specifically in case of this resource, the response code 422 shall also be returned if the NFVO has tested diff --git a/src/SOL005/NSLifecycleManagement/definitions/SOL005NSLifecycleManagement_def.yaml b/src/SOL005/NSLifecycleManagement/definitions/SOL005NSLifecycleManagement_def.yaml index 5a26c1781ae67756bdbba7046066bcd896564f48..a77d3fc55235667585ba9a9107ee8170a1938139 100644 --- a/src/SOL005/NSLifecycleManagement/definitions/SOL005NSLifecycleManagement_def.yaml +++ b/src/SOL005/NSLifecycleManagement/definitions/SOL005NSLifecycleManagement_def.yaml @@ -181,13 +181,15 @@ definitions: description: > Cancellation mode. - The NFVO shall not start any new VNF lifecycle management and resource + If the NS LCM operation occurrence is in "PROCESSING" or "ROLLING_BACK" + state, the NFVO shall not start any new VNF lifecycle management and resource management operation, and shall wait for the ongoing VNF lifecycle management and resource management operations in the underlying system, typically the VNFM and VIM, to finish execution or to time out. After that, the NFVO shall put the operation occurrence into the FAILED_TEMP state. - The NFVO shall not start any new VNF lifecycle management and resource + If the NS LCM operation occurrence is in "PROCESSING" or "ROLLING_BACK" + state, the NFVO shall not start any new VNF lifecycle management and resource management operation, shall cancel the ongoing VNF lifecycle management and resource management operations in the underlying system, typically the VNFM and VIM, and shall wait for the cancellation to finish or to time out. After that, the NFVO @@ -238,7 +240,10 @@ definitions: $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" versionDependency: description: > - Describes version dependencies currently valid for the nested NS instance. Identifies versions of descriptors of other constituents in the NSD upon which the nested NS depends. The dependencies may be described for the NSD referenced in this NsInfo with nsdId and for NSDs with the same NsdExtInvariantId. + Describes version dependencies currently valid for the nested NS instance. Identifies versions + of descriptors of other constituents in the NSD upon which the nested NS depends. + The dependencies may be described for the NSD referenced in this NsInfo with nsdId and for + NSDs with the same "nsdExtInvariantId". There shall not be more than one versionDependency present with the same dependentConstituentId. It may be present for the NsInfo of a nested NS. It shall not be present otherwise. type: array @@ -418,14 +423,14 @@ definitions: type: string enum: - Deployment - - Statefulset + - StatefulSet VnfInstance: description: > This type represents a VNF instance. It shall comply with the provisions defined in table 6.5.3.57-1. NOTE: Clause B.3.2 of ETSI GS NFV-SOL 003 provides examples illustrating the relationship among the - different run-time information elements (CP, VL and link ports) used to represent the connectivity + different run-time data types (CP, VL and link ports) used to represent the connectivity of a VNF. NOTE 1: Modifying the value of this attribute shall not be performed when conflicts exist between the @@ -497,9 +502,9 @@ definitions: description: > Describes version dependencies currently valid for the VNF instance. Identifies versions of descriptors of other constituents in the NSD upon which the VNF depends. - The dependencies may be described for the VNFD referenced in this VnfInfo with vnfdId - and for VNFDs with the same VnfdExtInvariantId. - There shall not be more than one versionDependency present with the same + The dependencies may be described for the VNFD referenced in this VnfInfo with "vnfdId" + and for VNFDs with the same "vnfdExtInvariantId". + There shall not be more than one "versionDependency" present with the same dependentConstituentId. type: array items: @@ -963,7 +968,7 @@ definitions: Identifies versions of descriptors of other constituents in the NSD upon which the PNF depends. The dependencies may be described for the PNFD referenced in this PnfInfo with pnfdId - and for PNFDs with the same PnfdExtInvariantId. + and for PNFDs with the same "pnfdExtInvariantId". There shall not be more than one versionDependency present with the same dependentConstituentId. type: array items: @@ -1585,6 +1590,9 @@ definitions: loadBalancerIp: description: Fixed addresses assigned to an external load balancer. $ref: "#/definitions/IpAddress" + addressPoolName: + description: Name of an address pool from which an IP address is assigned to the virtual CP. + type: string @@ -2332,37 +2340,37 @@ definitions: This type represents request parameters for the "Instantiate NS" operation. NOTE 1: The DF of the VNF instance shall match the VNF DF present in the associated VNF Profile. - The VNFD of the VNF instance shall match the one in the associated VNF Profile if no overridingVnfdId - is provided in the interface as part of vnfInstanceData, or the overridingVnfdId provided in the + The VNFD of the VNF instance shall match the one in the associated VNF Profile if no "overridingVnfdId" + is provided in the interface as part of "vnfInstanceData", or the "overridingVnfdId" provided in the interface if it is provided. NOTE 2: The NS DF of each nested NS shall be one of the allowed flavours in the associated NSD (as referenced in the nestedNsd attribute of the NSD of the NS to be instantiated). NOTE 3: The NSD of each referenced NSs (i.e. each nestedInstanceId) shall match the one of the nested - NSD in the composite NSD if no overridingNsdId is provided in the interface as part of NestedNsInstanceData, - or the overridingNsdId provided in the interface if it is provided. + NSD in the composite NSD if no "overridingNsdId" is provided in the interface as part of NestedNsInstanceData, + or the "overridingNsdId" provided in the interface if it is provided. NOTE 4: When the NS is deployed over several sites, the VLs of this NS will include VNs in each site connected over the WAN. In this case, the "wanConnectionData" provides the needed information required to connect each VN to the WAN. Annex E provides additional information and guidelines about the usage of the "wanConnectionData" attribute. - NOTE 5: The target size for NS instantiation may be specified in either nsInstantiationLevelId - or targetNsScaleLevelInfo, but not both. If none of the two parameters (nsInstantiationLevelId or - targetNsScaleLevelInfo) are present, the default NS instantiation level as declared in the NSD shall be used. - NOTE 6: If targetNsScaleLevelInfo is specified, information provided in targetNsScaleLevelInfo shall be used + NOTE 5: The target size for NS instantiation may be specified in either "nsInstantiationLevelId" + or "targetNsScaleLevelInfo", but not both. If none of the two parameters "nsInstantiationLevelId" or + "targetNsScaleLevelInfo" are present, the default NS instantiation level as declared in the NSD shall be used. + NOTE 6: If "targetNsScaleLevelInfo" is specified, information provided in "targetNsScaleLevelInfo" shall be used to calculate the number of instances of the VNFs/nested NSs referred in the NSD. For VNFs or nested NSs that - are not scalable based on targetNsScaleLevelInfo, the default NS instantiation level as declared in the NSD + are not scalable based on "targetNsScaleLevelInfo", the default NS instantiation level as declared in the NSD shall be used to calculate the number of instances those VNFs/nested NSs. NOTE 7: When "feasibilityCheckReserve" is set to FEASIBILITY_CHECK_ONLY, the "startTime" attribute shall be ignored. - NOTE 8: When feasibilityCheckReserve is set to NO_FEASIBILITY_CHECK, the feasibility checking procedure is not performed. + NOTE 8: When "feasibilityCheckReserve" is set to NO_FEASIBILITY_CHECK, the feasibility checking procedure is not performed. Resources might be reserved as triggered by means outside the present operation request (e.g., configuration or policies), e.g. if it is a scheduled NS instantiation operation. See Annex A.2.3 in ETSI GS NFV-IFA 010. - NOTE 9: When feasibilityCheckReserve is set to FEASIBILITY_CHECK_ONLY, only feasibility checking procedure + NOTE 9: When "feasibilityCheckReserve" is set to FEASIBILITY_CHECK_ONLY, only feasibility checking procedure is performed for the operation, no resources are reserved. - NOTE 10: When feasibilityCheckReserve is set to FEASIBILITY_CHECK_WITH_OPERATION, the feasibility checking + NOTE 10: When "feasibilityCheckReserve" is set to FEASIBILITY_CHECK_WITH_OPERATION, the feasibility checking procedure is performed and based on the procedure result, the actual NS instantiation operation is performed at the time indicated by the "startTime" attribute, if provided. Resources might be reserved as triggered by means outside the present operation request (e.g., configuration or policies), e.g. if it is a scheduled NS instantiation operation. See Annex A.2.3 in ETSI GS NFV-IFA 010. - NOTE 11: When feasibilityCheckReserve is set to FEASIBILITY_CHECK_WITH_RESERVATION_AND_OPERATION, the feasibility + NOTE 11: When "feasibilityCheckReserve" is set to FEASIBILITY_CHECK_WITH_RESERVATION_AND_OPERATION, the feasibility checking is performed and based on the procedure result, resources are reserved as part of the feasibility check, and the actual NS instantiation operation is performed using the resources reserved during the feasibility checking procedure execution, and at the time indicated by the "startTime" attribute, if provided. @@ -2524,12 +2532,12 @@ definitions: NOTE 1: This attribute allows for a nested NS at instantiation of the composite NS the use of an NSD different from the one specified in the - NSD of the composite NS with nsProfileId, provided they have the same nsdExtInvariantId. + NSD of the composite NS with "nsProfileId", provided they have the same "nsdExtInvariantId". NOTE 2: A VnfProfile, NsProfile or PnfProfile may contain multiple VersionDependencies as it may describe the version dependencies of the descriptor referenced in the profile or of other descriptors with the same external invariant identifier. - NOTE 3: The overridingVersionDependency attribute may only be present if - the overrridingNsdId attribute is present. + NOTE 3: The "overridingVersionDependency" attribute may only be present if + the "overridingNsdId" attribute is present. type: object required: - nsProfileId @@ -2547,28 +2555,29 @@ definitions: overridingNsdId: description: > Reference to an NSD. - If present it replaces the nsdId indicated in the referenced NsProfile + If present it replaces the "nsdId" indicated in the referenced NsProfile at the instantiation of the nested NS. The NSD referenced by this - ttribute shall have the same nsdExtInvariantId as the one indicated - in the NsProfile. If the NsProfile does not contain an nsdExtInvariantId + ttribute shall have the same "nsdExtInvariantId" as the one indicated + in the NsProfile. If the NsProfile does not contain an "nsdExtInvariantId" this attribute shall be ignored. See notes 1 and 3. $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" overridingVersionDependency: description: > - If present, information in each overridingVersionDependency replaces - the versionDependency in the runtime information that the NFVO + If present, information in each "overridingVersionDependency" replaces + the "versionDependency" in the runtime information that the NFVO keeps about the VnfProfile, NsProfile or PnfProfile indicated in the OverridingVersionDependency. - Only the versionDependency in the VnfProfile, NsProfile or PnfProfile - with the same dependentConstituentId as in the overridingVersionDependency + Only the "versionDependency" in the VnfProfile, NsProfile or PnfProfile + with the same "dependentConstituentId" as in the "overridingVersionDependency" is replaced. See note 2. - If no versionDependency with the dependentConstituentId indicated in - the overridingVersionDependency exists in the VnfProfile, NsProfile - or PnfProfile, the new versionDependency is added to the runtime information + If no "versionDependency" with the "dependentConstituentId" indicated in + the "overridingVersionDependency" exists in the VnfProfile, NsProfile + or PnfProfile, the new "versionDependency" is added to the runtime information that the NFVO keeps about the profile. See note 3. $ref: "#/definitions/OverridingVersionDependency" + ParamsForVnf: description: > @@ -2577,50 +2586,64 @@ definitions: It shall comply with the provisions defined in Table 6.5.3.22-1. NOTE 1: This attribute allows at VNF instantiation the use of a VNFD different - from the one specified in the NSD with vnfProfileId provided the two VNFDs refer - to the same vnfdExtInvariantId. + from the one specified in the NSD with "vnfProfileId" provided the two VNFDs refer + to the same vnfdExtInvariantId. NOTE 2: A VnfProfile, NsProfile or PnfProfile may contain multiple VersionDependencies - as it may describe the version dependencies of the descriptor referenced in the profile - or of other descriptors with the same external invariant identifier. - NOTE 3: The overridingVersionDependency attribute may only be present if the overrridingVnfdId - attribute is present. + as it may describe the version dependencies of the descriptor referenced in the profile + or of other descriptors with the same external invariant identifier. + NOTE 3: The "overridingVersionDependency" attribute may only be present if the "overridingVnfdId" + attribute is present. + NOTE 4: If "targetScaleLevelInfo" is specified, information provided in "targetScaleLevelInfo" shall be used for + instantiating scalable constituents of the VNF (e.g. VDUs/VLs). For scaling aspects not specified in + "targetScaleLevelInfo" or for the VNF constituents (e.g. VDUs/VLs) that are not scalable, the default + instantiation level as declared in the VNFD shall be used for instantiation. type: object required: - vnfProfileId properties: vnfProfileId: description: > - Identifier of (reference to) a vnfProfile to which the - additional parameters apply. + Identifier of the VnfProfile applicable to the VNF instance to which the + additional parameters apply $ref: "#/definitions/IdentifierInNsd" overridingVnfdId: description: > Reference to a VNFD. - If present it replaces the vnfdId indicated in the referenced + If present it replaces the "vnfdId" indicated in the referenced VnfProfile at the VNF instantiation. The VNFD referenced by this - attribute shall have the same vnfdExtInvariantId as the one indicated + attribute shall have the same "vnfdExtInvariantId" as the one indicated in the VnfProfile. If the VnfProfile does not contain a - vnfdExtInvariantId this attribute shall be ignored. + "vnfdExtInvariantId" this attribute shall be ignored. See notes 1 and 3. $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" overridingVersionDependency: description: > - If present, information in each overridingVersionDependency replaces - the versionDependency in the runtime information that the NFVO keeps + If present, information in each "overridingVersionDependency" replaces + the "versionDependency" in the runtime information that the NFVO keeps about the VnfProfile, NsProfile or PnfProfile indicated in the OverridingVersionDependency. - Only the versionDependency in the VnfProfile, NsProfile or PnfProfile - with the same dependentConstituentId as in the overridingVersionDependency + Only the "versionDependency" in the VnfProfile, NsProfile or PnfProfile + with the same "dependentConstituentId" as in the "overridingVersionDependency" is replaced. See note 2. - If no versionDependency with the dependentConstituentId indicated in the - overridingVersionDependency exists in the VnfProfile, NsProfile or PnfProfile, - the new versionDependency is added to the runtime information that the NFVO + If no "versionDependency" with the "dependentConstituentId" indicated in the + "overridingVersionDependency" exists in the VnfProfile, NsProfile or PnfProfile, + the new "versionDependency" is added to the runtime information that the NFVO keeps about the profile. See note 3. type: array items: $ref: "#/definitions/OverridingVersionDependency" + targetScaleLevelInfo: + description: > + This attribute is applicable if VNF supports target scale + level instantiation. + For each scaling aspect of the current deployment + flavour, the attribute specifies the scale level of VNF + constituents (e.g. VDU level) to be instantiated. See note 4 + type: array + items: + $ref: "#/definitions/VnfScaleInfo" vnfInstanceName: @@ -2754,12 +2777,12 @@ definitions: This type specifies an existing VNF instance to be used in the NS instance and if needed, the VNF Profile to use for this VNF instance. It shall comply with the provisions defined in Table 6.5.3.19-1. - NOTE 1: If the overridingVnfdId attribute is present the vnfProfileId attribute shall also be present. + NOTE 1: If the "overridingVnfdId" attribute is present the "vnfProfileId" attribute shall also be present. NOTE 2: This attribute allows to use an existing VNF instance based on a different VNFD to the one specified - in the NSD with vnfProfileId, provided both have the same vnfdExtInvariantId. + in the NSD with "vnfProfileId", provided both have the same "vnfdExtInvariantId". NOTE 3: A VnfProfile, NsProfile or PnfProfile may contain multiple VersionDependencies as it may describe the version dependencies of the descriptor referenced in the profile or of other descriptors with the same external invariant identifier. - NOTE 4: The overridingVersionDependency attribute may only be present if the overridingVnfdId attribute is present. + NOTE 4: The "overridingVersionDependency" attribute may only be present if the "overridingVnfdId" attribute is present. type: object oneOf: - required: @@ -2786,12 +2809,12 @@ definitions: overridingVnfdId: description: > Reference to a VNFD. - It replaces the vnfdId indicated in the vnfProfileId. + It replaces the "vnfdId" indicated in the "vnfProfileId". The VNFD referenced by this attribute shall have the same - vnfdExtInvariantId as the one indicated in the VnfProfile. - If the VnfProfile does not contain a vnfdExtInvariantId this + "vnfdExtInvariantId" as the one indicated in the VnfProfile. + If the VnfProfile does not contain a "vnfdExtInvariantId" this attribute shall be ignored. If the VNFD of the existing VNF - instance referenced by vnfInstanceId does not match the VNFD + instance referenced by "vnfInstanceId" does not match the VNFD indicated by this attribute the VNF instance shall not be added to the NS instance. See notes 1, 2 and 4. $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" @@ -2820,12 +2843,12 @@ definitions: and if needed, the NsProfile to use for this nested NS instance. It shall comply with the provisions defined in Table 6.5.3.19a-1. - NOTE 1: If the overridingNsdId attribute is present the nsProfileId attribute shall also be present. + NOTE 1: If the "overridingNsdId" attribute is present the "nsProfileId" attribute shall also be present. NOTE 2: This attribute allows to use as nested NS an existing NS instance based on a different NSD to the one - specified in the composite NSD with nsProfileId, provided they have the same nsdExtInvariantId. + specified in the composite NSD with "nsProfileId", provided they have the same "nsdExtInvariantId". NOTE 3: A VnfProfile, NsProfile or PnfProfile may contain multiple VersionDependencies as it may describe the version dependencies of the descriptor referenced in the profile or of other descriptors with the same external invariant identifier. - NOTE 4: The overridingVersionDependency attribute may only be present if the overridingNsdId attribute is present. + NOTE 4: The "overridingVersionDependency" attribute may only be present if the "overridingNsdId" attribute is present. type: object oneOf: @@ -2849,16 +2872,16 @@ definitions: If not present, the NFVO will select the NsProfile matching the information in the nested NS instance. See note 1. $ref: "#/definitions/IdentifierInNsd" - overridingNsddId: + overridingNsdId: description: > Reference to an NSD. - It replaces the nsdId indicated in the nsProfileId. + It replaces the "nsdId" indicated in the "nsProfileId". The NSD referenced by this attribute shall have the - same nsdExtInvariantId as the one indicated in the + same "nsdExtInvariantId" as the one indicated in the NsProfile. If the NsProfile does not contain an - nsdExtInvariantId this attribute shall be ignored. + "nsdExtInvariantId" this attribute shall be ignored. If the NSD of the existing NS instance referenced - by nestedNsInstanceId does not match the NSD + by "nestedNsInstanceId" does not match the NSD indicated by this attribute the NS instance shall not be added as nested NS to the composite NS instance. @@ -2867,17 +2890,17 @@ definitions: $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" overridingVersionDependency: description: > - If present, information in each overridingVersionDependency - replaces the versionDependency in the runtime information that + If present, information in each "overridingVersionDependency" + replaces the "versionDependency" in the runtime information that the NFVO keeps about the VnfProfile, NsProfile or PnfProfile indicated in the OverridingVersionDependency. - Only the versionDependency in the VnfProfile, NsProfile - or PnfProfile with the same dependentConstituentId as in - the overridingVersionDependency is replaced. See note 3. + Only the "versionDependency" in the VnfProfile, NsProfile + or PnfProfile with the same "dependentConstituentId" as in + the "overridingVersionDependency" is replaced. See note 3. - If no versionDependency with the dependentConstituentId indicated - in the overridingVersionDependency exists in the VnfProfile, NsProfile - or PnfProfile, the new versionDependency is added to the runtime + If no "versionDependency" with the "dependentConstituentId" indicated + in the "overridingVersionDependency" exists in the VnfProfile, NsProfile + or PnfProfile, the new "versionDependency" is added to the runtime information that the NFVO keeps about the profile. See note 4. type: array @@ -3287,35 +3310,35 @@ definitions: InstantiateVnfData: description: > - This type represents the information related to a SAP of a NS. The InstantiateVnfData data type specifies the - parameters that are needed for VNF instantiation. This information element is used for the bottom-up NS creation when - the OSS/BSS explicitly requests VNF instantiation for a given NS. When the NFVO invokes the Instantiate VNF - update operation, a set of these parameters are then passed by the NFVO to the VNFM. + The InstantiateVnfData data type specifies the parameters that are needed for VNF instantiation. This + information element is used for the bottom-up NS creation when the OSS/BSS explicitly requests VNF + instantiation for a given NS. When the NFVO invokes the Instantiate VNF update operation, a set of + these parameters are then passed by the NFVO to the VNFM. NOTE 1: It is possible to have several ExtManagedVirtualLinkData for the same VNF internal VL in case of a multi-site VNF spanning several VIMs. The set of ExtManagedVirtualLinkData corresponding to the same VNF internal VL shall indicate so by referencing to the same VnfVirtualLinkDesc and externally-managed multi-site VL instance (refer to clause 6.5.3.27). - NOTE 2: If vnfdId and vnfFlavourId (and vnfInstantiationLevelId, if provided) are present, - there should be only one vnfProfile that matches the vnfdId and vnfFlavourId (and vnfInstantiationLevelId, - if present) in the NS deployment flavour specified in the NSD associated to the NS instance to which - the present operation is triggered. In the case there is more than one matching vnfProfile, the NFVO - may select a matching vnfProfile based on other information, such as external VL. - NOTE 3: Either the attribute triple "vnfdId, vnfFlavourId and vnfInstantiationLevelId - (if provided)" or the attribute "vnProfileId" shall be present, but not both. - NOTE 4: The target size for VNF instantiation may be specified in either vnfInstantiationLevelId or - targetScaleLevelInfo, but not both. If none of the two attributes (vnfInstantiationLevelId or - targetScaleLevelInfo) are present, the default instantiation level as declared in the VNFD shall be used. - NOTE 5: If targetScaleLevelInfo is specified, information provided in targetScaleLevelInfo shall be used for instantiating - scalable constituents of the VNF (e.g, VDUs/VLs). For scaling aspects not specified in targetScaleLevelInfo - or for the VNF constituents (e.g., VDUs/VLs) that are not scalable, the default instantiation level as declared - in the VNFD shall be used for instantiation. - NOTE 6: If the overridingVnfdId attribute is present the vnfProfileId attribute shall also be present. - NOTE 7: This attribute allows at VNF instantiation the use of a VNFD different from the one specified - in the NSD with vnfProfileId provided the two VNFDs have the same vnfdExtInvariantId. + NOTE 2: If "vnfdId" and "vnfFlavourId" (and "vnfInstantiationLevelId", if provided) are present, there should be only one + vnfProfile that matches the "vnfdId" and "vnfFlavourId" (and "vnfInstantiationLevelId", if present) in the NS + deployment flavour specified in the NSD associated to the NS instance to which the present operation is + triggered. In the case there is more than one matching vnfProfile, the NFVO may select a matching vnfProfile + based on other information, such as external VL. + NOTE 3: Either the attribute triple "vnfdId", "vnfFlavourId" and "vnfInstantiationLevelId" (if provided) or the attribute + "vnProfileId" shall be present, but not both. + NOTE 4: The target size for VNF instantiation may be specified in either "vnfInstantiationLevelId" or + "targetScaleLevelInfo", but not both. If none of the two attributes ("vnfInstantiationLevelId" or + "targetScaleLevelInfo") are present, the default instantiation level as declared in the VNFD shall be used. + NOTE 5: If "targetScaleLevelInfo" is specified, information provided in "targetScaleLevelInfo" shall be used for + instantiating scalable constituents of the VNF (e.g. VDUs/VLs). For scaling aspects not specified in + "targetScaleLevelInfo" or for the VNF constituents (e.g. VDUs/VLs) that are not scalable, the default + instantiation level as declared in the VNFD shall be used for instantiation. + NOTE 6: If the "overridingVnfdId" attribute is present the "vnfProfileId" attribute shall also be present. + NOTE 7: This attribute allows at VNF instantiation the use of a VNFD different from the one specified in the NSD with + "vnfProfileId" provided the two VNFDs have the same "vnfdExtInvariantId". NOTE 8: A VnfProfile, NsProfile or PnfProfile may contain multiple VersionDependencies as it may describe the version dependencies of the descriptor referenced in the profile or of other descriptors with the same external invariant identifier. - NOTE 9: The overridingVersionDependency attribute may only be present if the overridingVnfdId attribute is present. + NOTE 9: The "overridingVersionDependency" attribute may only be present if the "overridingVnfdId" attribute is present. type: object oneOf: @@ -3471,27 +3494,27 @@ definitions: overridingVnfdId: description: > Reference to a VNFD. - If present the vnfProfileId shall also be present. - It replaces the vnfdId indicated in the vnfProfileId. + If present the "vnfProfileId" shall also be present. + It replaces the "vnfdId" indicated in the "vnfProfileId". The VNFD referenced by this attribute shall have the same - vnfdExtInvariantId as the one indicated in the VnfProfile. - If the VnfProfile does not contain a vnfdExtInvariantId this + "vnfdExtInvariantId" as the one indicated in the VnfProfile. + If the VnfProfile does not contain a "vnfdExtInvariantId" this attribute shall be ignored. See notes 6, 7 and 9. $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" overridingVersionDependency: description: > - If present, information in each overridingVersionDependency - replaces the versionDependency in the runtime information that + If present, information in each "overridingVersionDependency" + replaces the "versionDependency" in the runtime information that the NFVO keeps about the VnfProfile, NsProfile or PnfProfile indicated in the OverridingVersionDependency. - Only the versionDependency in the VnfProfile, NsProfile or - PnfProfile with the same dependentConstituentId as in the - overridingVersionDependency is replaced. See note 8. + Only the "versionDependency" in the VnfProfile, NsProfile or + PnfProfile with the same "dependentConstituentId" as in the + "overridingVersionDependency" is replaced. See note 8. - If no versionDependency with the dependentConstituentId indicated - in the overridingVersionDependency exists in the VnfProfile, NsProfile + If no "versionDependency" with the "dependentConstituentId" indicated + in the "overridingVersionDependency" exists in the VnfProfile, NsProfile or PnfProfile, the new version Dependency is added to the runtime information that the NFVO keeps about the profile. See note 9. @@ -3509,26 +3532,23 @@ definitions: The type represents the information that is requested to be changed deployment flavor for an existing VNF instance. NOTE 1: The indication of externally-managed internal VLs - is needed in case networks have been pre-configured for use with certain VNFs, - for instance to ensure that these networks have certain properties such as - security or acceleration features, or to address particular network topologies. - The present document assumes that externally-managed internal VLs are managed - by the NFVO and created towards the VIM. + is needed in case networks have been pre-configured for use with certain VNFs, + for instance to ensure that these networks have certain properties such as + security or acceleration features, or to address particular network topologies. + The present document assumes that externally-managed internal VLs are managed + by the NFVO and created towards the VIM. NOTE 2: It is possible to have several ExtManagedVirtualLinkData for the same - VNF internal VL in case of a multi-site VNF spanning several VIMs. The set - of ExtManagedVirtualLinkData corresponding to the same VNF internal VL shall - indicate so by referencing to the same VnfVirtualLinkDesc and externally-managed - multi-site VL instance (refer to clause 6.5.3.27). - NOTE 3: The target size for VNF instantiation may be specified in either - instantiationLevelId or targetScaleLevelInfo, but not both. If none of the - two attributes (instantiationLevelId or targetScaleLevelInfo) are present, - the default instantiation level as declared in the VNFD shall be used. - NOTE 4: If targetScaleLevelInfo is specified, information provided in - targetScaleLevelInfo shall be used for instantiating scalable constituents - of the VNF (e.g, VDUs/VLs). For scaling aspects not specified in - targetScaleLevelInfo or for the VNF constituents (e.g., VDUs/VLs) that - are not scalable, the default instantiation level as declared in the VNFD - shall be used for instantiation. + VNF internal VL in case of a multi-site VNF spanning several VIMs. The set + of ExtManagedVirtualLinkData corresponding to the same VNF internal VL shall + indicate so by referencing to the same VnfVirtualLinkDesc and externally-managed + multi-site VL instance (refer to clause 6.5.3.27). + NOTE 3: TThe target size for VNF instantiation may be specified in either "instantiationLevelId" or "targetScaleLevelInfo", + but not both. If none of the two attributes ("instantiationLevelId" or "targetScaleLevelInfo") are present, the + default instantiation level as declared in the VNFD shall be used. + NOTE 4: If "targetScaleLevelInfo" is specified, information provided in "targetScaleLevelInfo" shall be used for + instantiating scalable constituents of the VNF (e.g. VDUs/VLs). For scaling aspects not specified in + "targetScaleLevelInfo" or for the VNF constituents (e.g. VDUs/VLs) that are not scalable, the default + instantiation level as declared in the VNFD shall be used for instantiation. type: object oneOf: - required: @@ -3760,13 +3780,14 @@ definitions: nsdInvariantId of the NSD version that is to be associated to this NS instance is different from the one used before, the NFVO shall reject the request. Only new versions of the same NSD can be associated to an existing NS instance. This data type shall comply with the provisions defined in Table 6.5.3.34-1. - NOTE: The replacement of VNF instances, nested NS instances or PNF instances - by instances whose descriptor is referenced by the new NSD is applicable even if - the instance with a descriptor not referenced from the new NSD has the same - VnfdExtInvariantId, NsdExtInvariantId or PnfdExtInvariantId as the new one, i.e. - the synchronization procedure is based on descriptor identities of NSD constituents, - and does not consider VnfdExtInvariantId, NsdExtInvariantId or PnfdExtInvariantId - values. + NOTE 1: The replacement of VNF instances, nested NS instances or PNF instances by instances whose descriptor is + referenced by the new NSD is applicable even if the instance with a descriptor not referenced from the new + NSD has the same "vnfdExtInvariantId", "nsdExtInvariantId" or "pnfdExtInvariantId" as the new one, i.e. the + synchronization procedure is based on descriptor identities of NSD constituents, and does not consider + "vnfdExtInvariantId", "nsdExtInvariantId" or "pnfdExtInvariantId" values. + NOTE 2: The attributes "additionalParamsForNs", " additionalParamsForVnf", "additionalParamsForNestedNs" and + "additionalParamsForSap" may be specified when the attribute sync is set to true, and additional parameters + at NS instance, VNF instance, nested NS instance and SAP level are to be specified, respectively. type: object required: - newNsdId @@ -3786,16 +3807,73 @@ definitions: lifecycle management operation to explicitly add/remove VNFs and modify information of VNF instances according to the new NSD). - The synchronization to the new NSD means e.g. - instantiating/adding those VNFs whose VNFD is - referenced by the new NSD version but not referenced - by the old one, terminating/removing those VNFs whose - VNFD is referenced by the old NSD version but not - referenced by the new NSD version, modifying - information of VNF instances to the new applicable - VNFD provided in the new NSD version. See note. - A cardinality of 0 indicates that synchronization shall not be done. + The synchronization to the new NSD means + - instantiating/adding those VNFs whose VNFD is + referenced by the new NSD version but not + referenced by the old one, + - terminating/removing those VNFs whose VNFD + is referenced by the old NSD version but not + referenced by the new NSD version, + - adding those VLs whose VLD is referenced by + the new NSD version but not referenced by the + old NSD version, + - removing those VLs whose VLD is referenced by + the old NSD version but not referenced by the + new NSD version, + - adding those nested NSs whose NSD is + referenced by the new NSD version but not + reference by the old NSD version, + - removing those nested NSs whose NSD is + referenced by the old NSD version, but not + referenced by the new NSD version, + - adding those SAPs whose SAPD is referenced + by the new NSD version but not referenced by + the old NSD version, + - removing those SAPs whose SAPD is referenced + by the old NSD version but not referenced by the + new NSD version, + - modifying information of VNF instances to the + new applicable VNFD provided in the new NSD + version. See note 1. + - etc. + A cardinality of 0 indicates that synchronization shall not + be done by the NFVO. See note 2. type: boolean + additionalParamsForNs: + description: > + Provides additional parameter(s) at the composite NS + instance level necessary to associate the new NSD + version (as opposed to the VNF level, which is covered in + additionalParamsForVnf, and as opposed to the nested + NS level, which is covered in + additionalParamsForNestedNs). See note 2. + $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" + additionalParamsForVNf: + description: > + Provides additional parameter(s) per VNF instance + necessary to associate the new NSD version (as + opposed to the composite NS level, which is covered in + additionalParamsforNs, and as opposed to the nested + NS level, which is covered in + additionalParamsForNestedNs). See note 2. + type: array + items: + $ref: "#/definitions/ParamsForVnf" + additionalParamsForNestedNs: + description: > + Provides additional parameter(s) per nested NS instance + (as opposed to the composite NS level, which is covered + in additionalParamsForNs, as opposed to the VNF level, + which is covered in additionalParamsForVnf). See note 2 + type: array + items: + $ref: "#/definitions/ParamsForNestedNs" + additionalParamsForSAP: + description: > + Provides additional parameter(s) for SAP(s). See note 2. + type: array + items: + $ref: "#/definitions/SapData" MoveVnfInstanceData: description: > @@ -4062,7 +4140,7 @@ definitions: to use for this PNF. It shall comply with the provisions defined in Table 6.5.3.14-1. NOTE 1: This attribute allows the use of a PNFD different from the one specified in - the NSD when adding the PNF to the NS, provided they have the same pnfdExtInvariantId. + the NSD when adding the PNF to the NS, provided they have the same "pnfdExtInvariantId". NOTE 2: A VnfProfile, NsProfile or PnfProfile may contain multiple VersionDependencies as it may describe the version dependencies of the descriptor referenced in the profile or of other descriptors with the same external invariant identifier. @@ -4079,8 +4157,8 @@ definitions: Identifier of the PNF. This identifier is allocated by the OSS/BSS. If different to the one indicated in the referenced PnfProfile it replaces it when adding the PNF to an NS. The PNFD referenced by this attribute shall - have the same pnfdExtInvariantId as the one indicated in the PnfProfile. If - the PnfProfile does not contain a pnfdExtInvariantId this attribute shall be ignored. + have the same "pnfdExtInvariantId" as the one indicated in the PnfProfile. If + the PnfProfile does not contain a "pnfdExtInvariantId" this attribute shall be ignored. See note 1. $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier" @@ -4110,16 +4188,16 @@ definitions: $ref: "#/definitions/PnfExtCpData" overridingVersionDependency: description: > - If present, information in each overridingVersionDependency replaces - the versionDependency in the runtime information that the NFVO keeps + If present, information in each "overridingVersionDependency" replaces + the "versionDependency" in the runtime information that the NFVO keeps about the VnfProfile, NsProfile or PnfProfile indicated in the OverridingVersionDependency. - Only the versionDependency in the VnfProfile, NsProfile or PnfProfile - with the same dependentConstituentId as in the overridingVersionDependency + Only the "versionDependency" in the VnfProfile, NsProfile or PnfProfile + with the same dependentConstituentId as in the "overridingVersionDependency" is replaced. See note 2. - If no versionDependency with the dependentConstituentId indicated in - the overridingVersionDependency exists in the VnfProfile, NsProfile - or PnfProfile, the new versionDependency is added to the runtime + If no "versionDependency" with the "dependentConstituentId" indicated in + the "overridingVersionDependency" exists in the VnfProfile, NsProfile + or PnfProfile, the new "versionDependency" is added to the runtime information that the NFVO keeps about the profile. type: array items: @@ -4131,6 +4209,12 @@ definitions: dependency in the runtime information that the NFVO keeps about a profile of a NSD constituent. It shall comply with the provisions defined in table 6.5.3.111-1. + NOTE: If the referenced profile contains a "versionDependency" with + a dependentConstituent equal to the one indicated in the + "versionDependency" attribute of this data type, the + "versionDependency" in this data type overrides the one + in the profile, otherwise it is added to the version + dependencies in the profile. type: object required: @@ -4139,13 +4223,10 @@ definitions: properties: profileId: description: > - Reference to a vnfProfile, nsProfile or pnfProfile where the versionDependency - overrides an existing versionDependency or is added to the existing version - dependencies. - If the referenced profile contains a versionDependency with a dependentConstituent - equal to the one indicated in the versionDependency attribute of this information - element, the versionDependency in this information element overrides the one in the - profile, otherwise it is added to the version dependencies in the profile. + Reference to a vnfProfile, nsProfile or pnfProfile where + the "versionDependency" overrides an existing + "versionDependency" or is added to the existing version + dependencies. See note. $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd" versionDependency: description: > @@ -5694,6 +5775,16 @@ definitions: description: > This type represents network address data for a virtual CP. It shall comply with the provisions defined in table 6.5.3.12a-1. + + NOTE 1: If the container cluster is set up to be able to configure an external load balancer this address will be + used, otherwise it will be ignored by the CISM. + NOTE 2: In case the cluster can configure an external load balancer but no loadBalancerIp is provided the + container cluster will assign an IP address. + NOTE 3: The attribute is only relevant if the virtual CP is instantiated in a cluster that supports configuration of IP + address pools for virtual CPs. Otherwise it shall be ignored. MetalLB is an example of a solution for + Kubernetes® that supports configuration of address pools for load balancer services. + NOTE 4: The loadBalancerIp and the addressPoolName attributes shall not be present at the same time. + type: object required: - type @@ -5709,12 +5800,16 @@ definitions: loadBalancerIp: description: > Fixed address to assign to an external load balancer. - - If the container cluster is set up to be able to configure an external - load balancer this address will be used, otherwise it will be ignored by the CISM. - In case the cluster can configure an external load balancer - but no loadBalancerIp is provided the container cluster will assign an IP address. + See notes 1, 2 and 4. $ref: "#/definitions/IpAddress" + addressPoolName: + description: > + Name of an address pool from which the + container cluster will assign an IP address to + the virtual CP. See notes 3 and 4. + type: array + items: + type: string @@ -6016,7 +6111,7 @@ definitions: NOTE: Cardinality greater than 1 is only applicable for specific cases where more than one network attachment definition resource is needed to fulfil the connectivity requirements of the VNF internal CP, e.g. to build a link redundant mated pair in SR-IOV cases. When more than one "netAttDefResourceId" is indicated, all shall belong to the same namespace as - defined by the corresponding "netAttDefResourceNamespace" attribute in the "NetAttDefResourceData". + defined by the corresponding "containerNamespace" attribute in the "resourceHandle" attribute in the "NetAttDefResourceData". type: object required: - cpdId @@ -6123,31 +6218,30 @@ definitions: network when connecting the CP to the external VL. NOTE 1: The following conditions apply to the attributes "linkPortId" and "cpProtocolData" - for an external CP instance connected or to be connected to a virtual network not - categorized as secondary container cluster network: - - At least one of the "linkPortId" and "cpProtocolData" attributes shall be present for - an external CP instance representing a subport that is to be created, or an external CP instance - that is to be created by creating the corresponding VNFC or VNF instance during the current or - a subsequent LCM operation, or for an existing external CP instance that is to be re-configured - or added to a particular external virtual link. - - If the "cpProtocolData" attribute is absent, the "linkPortId" attribute shall be provided - referencing a pre-created link port with pre-configured address information. - - If both "cpProtocolData" and "linkportId" are provided, the API consumer shall ensure that - the cpProtocolData can be used with the pre-created link port referenced by "linkPortId". + for an external CP instance connected or to be connected to a virtual network not + categorized as secondary container cluster network: + - At least one of the "linkPortId" and "cpProtocolData" attributes shall be present for + an external CP instance representing a subport that is to be created, or an external CP instance + that is to be created by creating the corresponding VNFC or VNF instance during the current or + a subsequent LCM operation, or for an existing external CP instance that is to be re-configured + or added to a particular external virtual link. + - If the "cpProtocolData" attribute is absent, the "linkPortId" attribute shall be provided + referencing a pre-created link port with pre-configured address information. + - If both "cpProtocolData" and "linkportId" are provided, the API consumer shall ensure that + the cpProtocolData can be used with the pre-created link port referenced by "linkPortId". NOTE 2: In case the NFVO manages its own identifier space, the NFVO may remap this identifier - when communicating with the VNFM. If the NFVO knows that there can be an identifier collision - when communicating with the VNFM by using the identifier from the OSS/BSS, the NFVO shall remap it. - NOTE 3: The following conditions apply to the attributes “netAttDefResourceId” and “cpProtocolData” - for an external CP instance connected or to be connected to a secondary container cluster network; - The "netAttDefResourceId" and "cpProtocolData" attributes shall both be absent for the deletion of - an existing external CP instance addressed by "cpInstanceId". - At least one of these attributes shall be present for a to-be-created external CP instance or - an existing external CP instance. + when communicating with the VNFM. If the NFVO knows that there can be an identifier collision + when communicating with the VNFM by using the identifier from the OSS/BSS, the NFVO shall remap it. + NOTE 3: The following conditions apply to the attributes "netAttDefResourceId" and "cpProtocolData" for an external CP + instance connected or to be connected to a secondary container cluster network: + − Void. + − At least one of these attributes shall be present for a to-be-created external CP instance or an existing + external CP instance. NOTE 4: Cardinality greater than 1 is only applicable for specific cases where more than one network - attachment definition resource is needed to fulfil the connectivity requirements of the external CP, - e.g. to build a link redundant mated pair in SR-IOV cases. When more than one "netAttDefResourceId" - is indicated, all shall belong to the same namespace as defined by the corresponding - "netAttDefResourceNamespace" attribute in the "NetAttDefResourceData". + attachment definition resource is needed to fulfil the connectivity requirements of the external CP, + e.g. to build a link redundant mated pair in SR-IOV cases. When more than one "netAttDefResourceId" + is indicated, all shall belong to the same namespace as defined by the corresponding + "containerNamespace" attribute in the "resourceHandle" attribute in the "NetAttDefResourceData". NOTE 5: Either "linkPortId" or "netAttDefResourceId" may be included, but not both. type: object oneOf: @@ -7649,9 +7743,9 @@ definitions: - descriptorId properties: descriptorId: - description: Identifies a VNFD, NSD or PNFD upon which the entity using this information element depends. - When more than one descriptor is indicated, they shall correspond to versions of the same VNF, NS or PNF - and they represent. alternatives, i.e. the presence of one of them fulfills the dependency. + description: Identifies a VNFD, NSD or PNFD upon which the entity using this data type depends. When more than + one descriptor is indicated, they shall correspond to versions of the same VNF, NS or PNF and they represent + alternatives, i.e. the presence of one of them fulfills the dependency. type: array items: $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInNsd" @@ -7712,7 +7806,7 @@ definitions: properties: cpInstanceId: description: > - Identifier of this VIP CP instance and of this VipCpInfo information element. + Identifier of this VIP CP instance and of this VipCpInfo structure. $ref: "#/definitions/IdentifierInVnf" cpdId: description: > diff --git a/src/SOL005/NSLifecycleManagementNotification/NSLifecycleManagementNotification.yaml b/src/SOL005/NSLifecycleManagementNotification/NSLifecycleManagementNotification.yaml index 7c62814e93837ede953818727f8be15c858ab779..979d5b858c81973cc36411b2d396d192605cd8bf 100644 --- a/src/SOL005/NSLifecycleManagementNotification/NSLifecycleManagementNotification.yaml +++ b/src/SOL005/NSLifecycleManagementNotification/NSLifecycleManagementNotification.yaml @@ -14,11 +14,11 @@ info: license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt - version: 2.10.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 + version: 2.11.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 005 V4.3.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/04.03.01_60/gs_NFV-SOL005v040301p.pdf + description: ETSI GS NFV-SOL 005 V4.4.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/04.04.01_60/gs_NFV-SOL005v040401p.pdf servers: - url: http://127.0.0.1/callback/v2 diff --git a/src/SOL005/NSPerformanceManagement/NSPerformanceManagement.yaml b/src/SOL005/NSPerformanceManagement/NSPerformanceManagement.yaml index e837c4c61a4609913b09168ce893f41a38de40ad..e5568da26a31af10a70522ad8287a712aa8d4ed1 100644 --- a/src/SOL005/NSPerformanceManagement/NSPerformanceManagement.yaml +++ b/src/SOL005/NSPerformanceManagement/NSPerformanceManagement.yaml @@ -16,11 +16,11 @@ info: license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt - version: 2.10.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 + version: 2.11.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 005 V4.3.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/04.03.01_60/gs_NFV-SOL005v040301p.pdf + description: ETSI GS NFV-SOL 005 V4.4.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/04.04.01_60/gs_NFV-SOL005v040401p.pdf servers: - url: http://127.0.0.1/nspm/v2 @@ -635,7 +635,7 @@ paths: # Identifier of the subscription. # This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response # to a POST request creating a new subscription resource. It can also be retrieved from the "id" attribute in the -# payload body of that response. +# message content of that response. # in: path # type: string # required: true @@ -798,7 +798,7 @@ components: Identifier of the PM job. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new PM job resource. It can also be retrieved from the "id" attribute in the - payload body of that response. + message content of that response. required: true style: simple explode: false @@ -824,7 +824,7 @@ components: This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new threshold resource. It can also be retrieved from the "id" - attribute in the payload body of that response. + attribute in the message content of that response. required: true style: simple explode: false @@ -906,9 +906,9 @@ components: PmJobs.Post.422: description: | - 422 Unprocessable Entity + 422 Unprocessable Content - content type of the payload body is supported and the payload body of a request contains syntactically correct + content type of the message content is supported and the message content of a request contains syntactically correct data but the data cannot be processed. The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013 [16], including rules for the presence of the response body. @@ -1115,10 +1115,10 @@ components: IndividualPmJob.Patch.422: description: | - 422 Unprocessable entity + 422 Unprocessable Content - Shall be returned upon the following error: The content type of the payload body is supported and the payload - body of a request contains syntactically correct data but the data cannot be processed. + Shall be returned upon the following error: The content type of the message content is supported and the + message content of a request contains syntactically correct data but the data cannot be processed. The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013 [16], including rules for the presence of the response body. Specifically in case of this resource, the response code 422 shall also be returned if the NFVO has tested @@ -1247,10 +1247,10 @@ components: Thresholds.Post.422: description: | - 422 Unprocessable entity + 422 Unprocessable Content - Shall be returned upon the following error: The content type of the payload body is supported and the payload - body of a request contains syntactically correct data but the data cannot be processed. + Shall be returned upon the following error: The content type of the message content is supported and the + message content of a request contains syntactically correct data but the data cannot be processed. The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013 [16], including rules for the presence of the response body. Specifically in case of this resource, the response code 422 shall also be returned if the NFVO has tested @@ -1452,10 +1452,10 @@ components: IndividualThreshold.Patch.422: description: | - 422 Unprocessable Entity + 422 Unprocessable Content - Shall be returned upon the following error: The content type of the payload body is supported and the payload - body of a request contains syntactically correct data but the data cannot be processed. + Shall be returned upon the following error: The content type of the message content is supported and the + message content of a request contains syntactically correct data but the data cannot be processed. The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013 [16], including rules for the presence of the response body. Specifically in case of this resource, the response code 422 shall also be returned if the NFVO has tested diff --git a/src/SOL005/NSPerformanceManagementNotification/NSPerformanceManagementNotification.yaml b/src/SOL005/NSPerformanceManagementNotification/NSPerformanceManagementNotification.yaml index a2ab4dd15a04eb411a867da592a3eb60a5de2e39..1eff66ef696f00e61ea0db3ecb7d3482c7a19bc0 100644 --- a/src/SOL005/NSPerformanceManagementNotification/NSPerformanceManagementNotification.yaml +++ b/src/SOL005/NSPerformanceManagementNotification/NSPerformanceManagementNotification.yaml @@ -16,11 +16,11 @@ info: license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt - version: 2.10.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 + version: 2.11.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 005 V4.3.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/04.03.01_60/gs_NFV-SOL005v040301p.pdf + description: ETSI GS NFV-SOL 005 V4.4.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/04.04.01_60/gs_NFV-SOL005v040401p.pdf servers: - url: http://127.0.0.1/callback/v2 diff --git a/src/SOL005/VNFPackageManagement/VNFPackageManagement.yaml b/src/SOL005/VNFPackageManagement/VNFPackageManagement.yaml index 4054387cd5f0956f2f59f664a4a96d882153a05c..899bc16f59876debaa4d82223162e4db8a86b9c1 100644 --- a/src/SOL005/VNFPackageManagement/VNFPackageManagement.yaml +++ b/src/SOL005/VNFPackageManagement/VNFPackageManagement.yaml @@ -16,11 +16,11 @@ info: license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt - version: 2.10.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 + version: 2.11.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 005 V4.3.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/04.03.01_60/gs_NFV-SOL005v040301p.pdf + description: ETSI GS NFV-SOL 005 V4.4.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/04.04.01_60/gs_NFV-SOL005v040401p.pdf servers: - url: http://127.0.0.1/vnfpkgm/v2 @@ -780,7 +780,7 @@ components: description: | Identifier of this subscription. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new "Individual subscription" resource. It can also be retrieved - from the "id" attribute in the payload body of that response. + from the "id" attribute in the message content of that response. required: true style: simple explode: false @@ -808,7 +808,7 @@ components: VnfPackageExtArtifactsRequest: description: | - The payload body contains the access configuration information based on which the NFVO can obtain the + The message content contains the access configuration information based on which the NFVO can obtain the external VNF package artifact files. content: application/json: @@ -824,18 +824,18 @@ components: file: type: string description: | - The payload body contains a ZIP file that represents the VNF package. The "Content-Type" HTTP header shall + The message content contains a ZIP file that represents the VNF package. The "Content-Type" HTTP header shall be set according to the type of the file, i.e. to "application/zip" for a VNF Package as defined in ETSI GS NFV-SOL 004. format: binary required: true VnfPackageUploadFromUriRequest: description: | - The payload body contains the address information based on which the NFVO can obtain the content of the VNF package. + The message content contains the address information based on which the NFVO can obtain the content of the VNF package. content: application/json: schema: - $ref: ./definitions/SOL005VNFPackageManagement_def.yaml#/definitions/UploadVnfPkgFromUriRequest + $ref: ./definitions/SOL005VNFPackageManagement_def.yaml#/definitions/UploadVnfPackageFromUriRequest required: true VnfPkgSubscriptionRequest: @@ -1107,7 +1107,7 @@ components: IndividualVnfPackageVnfd.Get.200: description: | 200 OK - Shall be returned when the content of the VNFD has been read successfully. The payload body shall contain a + Shall be returned when the content of the VNFD has been read successfully. The message content shall contain a copy of the file representing the VNFD or a ZIP file that contains the file or multiple files representing the VNFD, 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. @@ -1345,11 +1345,11 @@ components: 200 OK Shall be returned when the content of the manifest has been read successfully. If the "include_signatures" URI query parameter was absent in the request, or if the manifest file has all security-related information embedded - (i.e. there is no separate certificate file), the payload body shall contain a copy of the manifest file of the + (i.e. there is no separate certificate file), the message content shall contain a copy of the manifest file of the VNF package, and the "Content-Type" HTTP header shall be set to "text/plain". If the "include_signatures" URI query parameter was present in the related request and the manifest file does not have all the security-related information embedded (i.e. there is a separate certificate file), the "Content-Type" HTTP header shall be set to - "application/zip and the payload body shall contain a ZIP archive which includes: - a copy of the manifest file + "application/zip and the message content shall contain a ZIP archive which includes: - a copy of the manifest file of the VNF package - a copy of the related individual certificate file. headers: Version: @@ -1479,7 +1479,7 @@ components: If the NFVO supports range requests, this response shall be returned when a single consecutive byte range from the content of the VNF package file has been read successfully according to the request. The response body shall contain the requested part of the VNF package file. - The "Content-Range" HTTP header shall be provided according to IETF RFC 7233 [10]. + The "Content-Range" HTTP header shall be provided according to IETF RFC 9110. The "Content-Type" HTTP header shall be set as defined above for the "200 OK" response. headers: Version: @@ -1633,7 +1633,7 @@ components: description: | 200 OK Shall be returned when the whole content of the archive containing the artifact files has been read successfully. - The payload body shall be a ZIP archive containing the requested set of artifacts selected according to the provisions + The message content shall be a ZIP archive containing the requested set of artifacts selected according to the provisions specified above in this clause, and, if the flag "include_signatures" was provided in the related request, the applicable signature files and, if available, the separate certificate files from the VNF package. The "Content-Type" HTTP header shall be set to "application/zip". @@ -1670,7 +1670,7 @@ components: read successfully according to the request. The response body shall contain the requested part of the archive. The "Content-Type" HTTP header shall be set to "application/zip". - The "Content-Range" HTTP header shall be provided according to IETF RFC 7233 [10]. + The "Content-Range" HTTP header shall be provided according to IETF RFC 9110. headers: Version: description: | @@ -1821,14 +1821,14 @@ components: IndividualVnfPackageArtifact.Get.200: description: | 200 OK Shall be returned when the whole content of the artifact file has been read successfully. If the - "include_signatures" request URI parameter was not provided in the related request, the payload body shall - contain a copy of the artifact file from the VNF package, as defined by ETSI GS NFV-SOL 004 [5], and the + "include_signatures" request URI parameter was not provided in the related request, the message content shall + contain a copy of the artifact file from the VNF package, as defined by ETSI GS NFV-SOL 004, and the "Content-Type" HTTP header shall be set according to the content type of the artifact file. If the artifact - is encrypted, the header shall be set to the value "application/cms" (IETF RFC 7193 [17]). If the content + is encrypted, the header shall be set to the value "application/cms" (IETF RFC 7193). If the content type cannot be determined, the header shall be set to the value "application/octet-stream". If the "include_signatures" request URI parameter was provided in the related request, the "ContentType" - HTTP header shall be set to "application/zip" and the payload body shall contain a ZIP archive which includes: - - a copy of the artifact file from the VNF package, as defined by ETSI GS NFV-SOL 004 [5]; + HTTP header shall be set to "application/zip" and the message content shall contain a ZIP archive which includes: + - a copy of the artifact file from the VNF package, as defined by ETSI GS NFV-SOL 004; - the related security information (individual signature file and optional related individual certificate file). headers: Version: @@ -1861,10 +1861,10 @@ components: If the NFVO supports range requests and the "include_signatures" request URI parameter was not present in the related request, this response shall be returned when a single consecutive byte range from the content of the artifact file has been read successfully according to the request. The response body shall contain the - requested part of the artifact file from the VNF package, as defined by ETSI GS NFV-SOL 004 [5]. + requested part of the artifact file from the VNF package, as defined by ETSI GS NFV-SOL 004. The "Content-Type" HTTP header shall be set according to the content type of the artifact file. If the content type cannot be determined, the header shall be set to the value "application/octet-stream". - The "Content-Range" HTTP header shall be provided according to IETF RFC 7233 [10]. + The "Content-Range" HTTP header shall be provided according to IETF RFC 9110. headers: Version: @@ -2106,10 +2106,10 @@ components: VnfPkgSubscriptions.Post.422: description: | - 422 Unprocessable Entity + 422 Unprocessable Content - Shall be returned upon the following error: The content type of the payload body is supported and the payload - body of a request contains syntactically correct data but the data cannot be processed. + Shall be returned upon the following error: The content type of the message content is supported and the + message content of a request contains syntactically correct data but the data cannot be processed. The general cause for this error and its handling is specified in clause 6.4 of ETSI GS NFV-SOL 013 [16], including rules for the presence of the response body. Specifically in case of this resource, the response code 422 shall also be returned if the NFVO has tested diff --git a/src/SOL005/VNFPackageManagement/definitions/SOL005VNFPackageManagement_def.yaml b/src/SOL005/VNFPackageManagement/definitions/SOL005VNFPackageManagement_def.yaml index fbd217e88229d391db534ff8252dd4e7aa06b13c..54fdbbe2b2c869ab442dba29a1e325b3a226d55d 100644 --- a/src/SOL005/VNFPackageManagement/definitions/SOL005VNFPackageManagement_def.yaml +++ b/src/SOL005/VNFPackageManagement/definitions/SOL005VNFPackageManagement_def.yaml @@ -16,7 +16,6 @@ definitions: - onboardingState - operationalState - usageState - - vnfmInfo - _links properties: id: @@ -139,8 +138,11 @@ definitions: vnfmInfo: description: > Specifies VNFMs compatible with the VNF. - This information is copied from the VNFD. - See note 4. + This information is copied from the VNFD of + the on-boarded VNF package. See note 4. + It shall be present after the VNF package + content has been on-boarded and absent + otherwise. type: array items: type: string @@ -185,8 +187,14 @@ definitions: VnfPackageArtifactInfo: description: > - This type represents an artifact other than a software image which is contained in or external to a VNF package. - It shall comply with provisions defined in Table 9.5.3.3-1. + This type represents an artifact other than a software image which is contained + in or external to a VNF package. It shall comply with provisions defined in + Table 9.5.3.3-1. + + NOTE: The attribute name "artifactURI" does not comply with the naming convention + defined in clause 4.3 of ETSI GS NFV-SOL 015. This is to maintain the backward + compatibility. + required: - isEncrypted - checksum @@ -218,7 +226,10 @@ definitions: URI of the artifact as defined in the VNF package manifest. Shall be present if the artifact is external to the package and shall be absent otherwise. + EXAMPLE: https://example.com/m%40ster.sh + + See note. $ref: "../../definitions/SOL005_def.yaml#/definitions/Uri" checksum: description: > @@ -507,7 +518,7 @@ definitions: User defined data to be updated. For existing keys, the value is replaced. See note. $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs" - UploadVnfPkgFromUriRequest: + UploadVnfPackageFromUriRequest: description: > This type represents the request parameters for uploading the content of a VNF package. The NFVO can obtain the VNF package content through the information provided in the request parameters. It shall comply with the provisions @@ -528,28 +539,14 @@ definitions: authorization for downloading the VNF package. Permitted values: - - BASIC: Only the "username" and - "password" attributes shall be - present. - - OAUTH2_CLIENT_CREDENTIAL - S: Only the - "paramsOauth2ClientCredentials" + - OAUTH2_CLIENT_CREDENTIALS: + Only the "paramsOauth2ClientCredentials" attribute shall be present. - This attribute shall not be present if no - credentials are provided for the artifact. + This attribute shall not be present if the + credentials were provisioned out of band. type: string enum: - - BASIC - OAUTH2_CLIENT_CREDENTIALS - username: - description: > - User name to be used for authentication. - type: string - password: - description: > - Password to be used for authentication. - Shall not be present in response bodies. - type: string paramsOauth2ClientCredentials: description: > Parameters for authentication/authorization @@ -834,28 +831,13 @@ definitions: authorization for downloading the VNF package. Permitted values: - - BASIC: Only the "username" and - "password" attributes shall be - present. - - OAUTH2_CLIENT_CREDENTIAL - S: Only the - "paramsOauth2ClientCredentials" + - OAUTH2_CLIENT_CREDENTIALS: + Only the "paramsOauth2ClientCredentials" attribute shall be present. - This attribute shall not be present if no - credentials are provided for the artifact. + This attribute shall not be present if no credentials are provided for the artifact. type: string enum: - - BASIC - OAUTH2_CLIENT_CREDENTIALS - username: - description: > - User name to be used for authentication. - type: string - password: - description: > - Password to be used for authentication. - Shall not be present in response bodies. - type: string paramsOauth2ClientCredentials: description: > Parameters for authentication/authorization diff --git a/src/SOL005/VNFPackageManagementNotification/VNFPackageManagementNotification.yaml b/src/SOL005/VNFPackageManagementNotification/VNFPackageManagementNotification.yaml index 6ad48adbd8f1a953a412b432906411dae30c1d32..81874d2237b4f4aff4a57d77377a2e61267d0a9c 100644 --- a/src/SOL005/VNFPackageManagementNotification/VNFPackageManagementNotification.yaml +++ b/src/SOL005/VNFPackageManagementNotification/VNFPackageManagementNotification.yaml @@ -16,11 +16,11 @@ info: license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt - version: 2.10.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 + version: 2.11.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 005 V4.3.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/04.03.01_60/gs_NFV-SOL005v040301p.pdf + description: ETSI GS NFV-SOL 005 V4.4.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/04.04.01_60/gs_NFV-SOL005v040401p.pdf servers: - url: http://127.0.0.1/callback/v2 diff --git a/src/SOL005/VNFSnapshotPackageManagement/VNFSnapshotPackageManagement.yaml b/src/SOL005/VNFSnapshotPackageManagement/VNFSnapshotPackageManagement.yaml index f91012373b0a843a875378656dc5ab891616dbf4..df5159c0098901db3ead74670f1ed31a526291bd 100644 --- a/src/SOL005/VNFSnapshotPackageManagement/VNFSnapshotPackageManagement.yaml +++ b/src/SOL005/VNFSnapshotPackageManagement/VNFSnapshotPackageManagement.yaml @@ -16,11 +16,11 @@ info: license: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt - version: 1.10.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 + version: 1.11.0-impl:etsi.org:ETSI_NFV_OpenAPI:1 externalDocs: - description: ETSI GS NFV-SOL 005 V4.3.1 - url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/04.03.01_60/gs_NFV-SOL005v040301p.pdf + description: ETSI GS NFV-SOL 005 V4.4.1 + url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/005/04.04.01_60/gs_NFV-SOL005v040401p.pdf servers: - url: http://127.0.0.1/vnfsnapshotpkgm/v1 @@ -665,7 +665,7 @@ components: BuildVnfSnapshotPkgRequest: description: | - Request parameters for building the content of a VNF snapshot package, as defined in clause 11.5.2.6. + The message content contains the information based on which the NFVO can build the content of the VNF snapshot package. content: application/json: schema: @@ -674,7 +674,7 @@ components: ExtractVnfSnapshotPkgRequest: description: | - Request parameters for extracting the content of a VNF snapshot package, as defined in clause 11.5.2.7. + The message content contains the information based on which the NFVO can extract the content of the VNF snapshot package. content: application/json: schema: @@ -683,8 +683,7 @@ components: CancelVnfSnapshotPkgOperationRequest: description: | - Request parameters for cancelling an ongoing operation related to the content of a VNF snapshot package, - as defined in clause 11.5.2.8. + The message content contains the information based on which the NFVO can proceed with the cancellation. content: application/json: schema: @@ -692,7 +691,9 @@ components: required: true VnfSnapshotPkgExtArtifactsAccessConfig: - description: VOID + description: The message content contains the access configuration + information based on which the NFVO can obtain the external + VNF snapshot package artifact files. content: application/json: schema: @@ -1022,7 +1023,7 @@ components: VnfSnapshotPackageContent.Get.206: description: | - 206 PARTIAL CONTENT + 206 Partial Content If the NFVO supports range requests, this response shall be returned when a single consecutive byte range from the content of the VNF snapshot package file has been read successfully according @@ -1030,7 +1031,7 @@ components: The response body shall contain the requested part of the VNF snapshot package file. - The "Content-Range" HTTP header shall be provided according to IETF RFC 7233. + The "Content-Range" HTTP header shall be provided according to IETF RFC 9110. The "Content-Type" HTTP header shall be set as defined for the "200 OK" response. headers: @@ -1622,7 +1623,7 @@ components: type of the artifact file. If the content type cannot be determined, the header shall be set to the value "application/octet-stream". - The "Content-Range" HTTP header shall be provided according to IETF RFC 7233. + The "Content-Range" HTTP header shall be provided according to IETF RFC 9110. headers: Version: description: The used API version. diff --git a/src/SOL005/VNFSnapshotPackageManagement/definitions/SOL005VNFSnapshotPackageManagement_def.yaml b/src/SOL005/VNFSnapshotPackageManagement/definitions/SOL005VNFSnapshotPackageManagement_def.yaml index 7bbb2efc042450b295a8ee30d136151600562f36..dda19487a576aae97b8c9cdb8afa51a9c3cf1184 100644 --- a/src/SOL005/VNFSnapshotPackageManagement/definitions/SOL005VNFSnapshotPackageManagement_def.yaml +++ b/src/SOL005/VNFSnapshotPackageManagement/definitions/SOL005VNFSnapshotPackageManagement_def.yaml @@ -261,24 +261,12 @@ definitions: Defines the type of authentication / authorization for downloading the VNF snapshot package. Permitted values: - - BASIC: Only the "username" and "password" attributes shall be present. - OAUTH2_CLIENT_CREDENTIALS: Only the "paramsOauth2ClientCredentials" attribute shall be present. This attribute shall not be present if the credentials were provisioned out of band. type: string enum: - - BASIC - OAUTH2_CLIENT_CREDENTIALS - username: - description: > - Username to be used for authentication. Shall be present if user name is needed and has - not been provisioned out of band. - type: string - password: - description: > - Password to be used for authentication. Shall be present if password is needed and has - not been provisioned out of band. - type: string paramsOauth2ClientCredentials: description: > Parameters for authentication/authorization using OAuth 2.0. @@ -430,23 +418,13 @@ definitions: Defines the type of authentication / authorization for downloading the VNF package. Permitted values: - - BASIC: Only the "username" and "password" attributes shall be present. - OAUTH2_CLIENT_CREDENTIALS: Only the "paramsOauth2ClientCredentials" attribute shall be present. - This attribute shall not be present if no credentials are provided for the artifact. + This attribute shall not be present if no credentials are provided for the artifact type: string enum: - - BASIC - OAUTH2_CLIENT_CREDENTIALS - username: - description: > - Username to be used for authentication. - type: string - password: - description: > - Password to be used for authentication. Shall not be present in response bodies. - type: string paramsOauth2ClientCredentials: description: > Parameters for authentication/authorization using OAUTH2_CLIENT_CREDENTIALS. diff --git a/src/SOL005/components/SOL005_params.yaml b/src/SOL005/components/SOL005_params.yaml index 58220e1eeedb146b54c60c8444ceaf3d20c9ec0a..b17c2e76d3e489b638b6f1f6f4ec8369d61d6ce6 100644 --- a/src/SOL005/components/SOL005_params.yaml +++ b/src/SOL005/components/SOL005_params.yaml @@ -105,7 +105,7 @@ components: in: query description: | Flag (i.e. parameter without value) that instructs the NFVO to exclude the set of additional MANO artifacts - (i.e. those that are not images) from the response payload body. The NFVO shall support this parameter. + (i.e. those that are not images) from the response message content. The NFVO shall support this parameter. The OSS/BSS may supply this parameter. required: false style: form @@ -118,7 +118,7 @@ components: in: query description: | Flag (i.e. parameter without value) that instructs the NFVO to exclude the set of non-MANO artifacts from the - response payload body. The NFVO shall support this parameter. The OSS/BSS may supply this parameter. + response message content. The NFVO shall support this parameter. The OSS/BSS may supply this parameter. required: false style: form explode: true @@ -143,7 +143,7 @@ components: in: query description: | Flag (i.e. parameter without value) that instructs the NFVO to include external artifacts in the response - payload body. It shall not be treated as an error if this flag is provided but there is no external artifact + message content. It shall not be treated as an error if this flag is provided but there is no external artifact to include in the result. If this parameter is missing, no external artifacts shall be included. The NFVO shall support this parameter. The OSS/BSS may supply this parameter. required: false diff --git a/src/SOL005/responses/SOL005_resp.yaml b/src/SOL005/responses/SOL005_resp.yaml index 8ef9393b1dc7e0a9c856a72699a5bdbb07ec5bb5..08505002a6a1488e1a0a56f21d24a59fdaed46d4 100644 --- a/src/SOL005/responses/SOL005_resp.yaml +++ b/src/SOL005/responses/SOL005_resp.yaml @@ -109,7 +109,7 @@ components: "ProblemDetails" structure to be returned. If the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect - query parameters or the payload body contains a syntactically incorrect data structure), + query parameters or the message content contains a syntactically incorrect data structure), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem. @@ -241,7 +241,7 @@ components: This response code is not appropriate in case the resource addressed by the URI is a container resource which is designed to contain child resources, but does not contain any child resource at the time the request is received. For a GET request to an existing empty container resource, a typical response - contains a 200 OK response code and a payload body with an empty array. + contains a 200 OK response code and a message content with an empty array. headers: Content-Type: description: The MIME type of the body of the response. @@ -412,7 +412,7 @@ components: description: > 413 PAYLOAD TOO LARGE - If the payload body of a request is larger than the amount of data the API producer is willing or able to process, + If the message content of a request is larger than the amount of data the API producer is willing or able to process, it shall respond with this response code, following the provisions in IETF RFC 7231 for the use of the "Retry-After" HTTP header and for closing the connection. The "ProblemDetails" structure may be omitted. headers: @@ -513,7 +513,7 @@ components: description: > 422 UNPROCESSABLE ENTITY - If the payload body of a request contains syntactically correct data (e.g. well-formed JSON) but the data + If the message content of a request contains syntactically correct data (e.g. well-formed JSON) but the data cannot be processed (e.g. because it fails validation against a schema), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem.