[v5.2.1] Additional implementation of common error code 416 in the SOL002 OpenAPI VNFLCM operations without information in the SOL002/SOL013 specification
[Actual Status] Situation with SOL002 416 Response code:
- Is it in the SOL002 Word document? ×
- Is it in the SOL013 Word document? ×
- Is the content of SOL002 Word document in OpenAPI? - ※ It's not applicable as it doesn't exist in the Word document
- Is the content of SOL013 Word document in OpenAPI? - ※ It's not applicable as it doesn't exist in the Word document
- Other: Is the content of the 416 response in OpenAPI? 〇
[SOL002/SOL013 specification document]
In v5.2.1, The SOL013 specification document does not include a description for the common error code 416, as referenced in the SOL002 operations detailed in sections 5.4.2.3.1, 5.4.2.3.2, 5.4.3.3.2, 5.4.3.3.4, 5.4.3.3.5, 5.4.4.3.1, 5.4.5.3.1, 5.4.8.3.1, 5.4.9.3.1, 5.4.11.3.1, 5.4.14.3.1, 5.4.15.3.1, 5.4.18.3.1, 5.4.18.3.2, 5.4.19.3.2, 5.4.19.3.5
Example: 5.4.2.3.1
https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/002/05.02.01_60/gs_nfv-sol002v050201p.pdf
[OpenAPI]
On the other hand, there is a description for common error codes 416 in the SOL002 OpenAPI VNFLCM operations for
- POST Create a new vnfInstance resource as defined in 5.4.2.3.1 https://forge.etsi.org/rep/nfv/SOL002-SOL003/-/blob/v5.2.1/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml?ref_type=heads#L100
- GET information about multiple VNF instances resource defined in 5.4.2.3.2 https://forge.etsi.org/rep/nfv/SOL002-SOL003/-/blob/v5.2.1/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml?ref_type=heads#L63
- Get Information about an individual VNF Instance resource defined in 5.4.3.3.2 https://forge.etsi.org/rep/nfv/SOL002-SOL003/-/blob/v5.2.1/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml?ref_type=heads#L136
- PATCH Individual VNFInstance resource defined in 5.4.3.3.4 https://forge.etsi.org/rep/nfv/SOL002-SOL003/-/blob/v5.2.1/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml?ref_type=heads#L209
- DELETE Individual VNFInstance resource defined in 5.4.3.3.5 https://forge.etsi.org/rep/nfv/SOL002-SOL003/-/blob/v5.2.1/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml?ref_type=heads#L169
- POST Instantiate a vnfInstance resource defined in 5.4.4.3.1 https://forge.etsi.org/rep/nfv/SOL002-SOL003/-/blob/v5.2.1/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml?ref_type=heads#L290
- POST Scale a vnfInstance resource defined in 5.4.5.3.1 https://forge.etsi.org/rep/nfv/SOL002-SOL003/-/blob/v5.2.1/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml?ref_type=heads#L330
- POST Terminate a vnfInstance resource defined in 5.4.8.3.1 https://forge.etsi.org/rep/nfv/SOL002-SOL003/-/blob/v5.2.1/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml?ref_type=heads#L451
- POST Heal a vnfInstance resource defined in in 5.4.9.3.1 https://forge.etsi.org/rep/nfv/SOL002-SOL003/-/blob/v5.2.1/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml?ref_type=heads#L491
- POST Change External VNF Connectivity resource defined in 5.4.11.3.1 https://forge.etsi.org/rep/nfv/SOL002-SOL003/-/blob/v5.2.1/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml?ref_type=heads#L571
- Post Retry operation task resource defined in 5.4.14.3.1 https://forge.etsi.org/rep/nfv/SOL002-SOL003/-/blob/v5.2.1/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml?ref_type=heads#L732
- Post Rollback operation task resource defined in 5.4.15.3.1 https://forge.etsi.org/rep/nfv/SOL002-SOL003/-/blob/v5.2.1/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml?ref_type=heads#L772
- POST Create a new subscription resource defined in 5.4.18.3.1 https://forge.etsi.org/rep/nfv/SOL002-SOL003/-/blob/v5.2.1/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml?ref_type=heads#L925
- GET Individual Subscription resource defined in 5.4.18.3.2 https://forge.etsi.org/rep/nfv/SOL002-SOL003/-/blob/v5.2.1/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml?ref_type=heads#L890
- GET Show subscription resource defined in 5.4.19.3.2 https://forge.etsi.org/rep/nfv/SOL002-SOL003/-/blob/v5.2.1/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml?ref_type=heads#L962
- DELETE an individual subscription resource defined in 5.4.19.3.5 https://forge.etsi.org/rep/nfv/SOL002-SOL003/-/blob/v5.2.1/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml?ref_type=heads#L993
Inconsistencies with SOL documentation.
- Example: POST Create a new vnfInstance resource as defined in 5.4.2.3.1
https://forge.etsi.org/rep/nfv/SOL002-SOL003/-/blob/v5.2.1/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml?ref_type=heads#L100
[Problem]
The issue is that the content of the 416 response exists in OpenAPI.
[Conclusion]
Reference of common error code 416 should be removed from VNFLCM OpenAPI operation "VNFLifecycleManagement.yaml" file below operation.
- POST Create a new vnfInstance resource as defined in 5.4.2.3.1 https://forge.etsi.org/rep/nfv/SOL002-SOL003/-/blob/v5.2.1/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml?ref_type=heads#L100
- GET information about multiple VNF instances resource defined in 5.4.2.3.2 https://forge.etsi.org/rep/nfv/SOL002-SOL003/-/blob/v5.2.1/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml?ref_type=heads#L63
- Get Information about an individual VNF Instance resource defined in 5.4.3.3.2 https://forge.etsi.org/rep/nfv/SOL002-SOL003/-/blob/v5.2.1/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml?ref_type=heads#L136
- PATCH Individual VNFInstance resource defined in 5.4.3.3.4 https://forge.etsi.org/rep/nfv/SOL002-SOL003/-/blob/v5.2.1/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml?ref_type=heads#L209
- DELETE Individual VNFInstance resource defined in 5.4.3.3.5 https://forge.etsi.org/rep/nfv/SOL002-SOL003/-/blob/v5.2.1/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml?ref_type=heads#L169
- POST Instantiate a vnfInstance resource defined in 5.4.4.3.1 https://forge.etsi.org/rep/nfv/SOL002-SOL003/-/blob/v5.2.1/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml?ref_type=heads#L290
- POST Scale a vnfInstance resource defined in 5.4.5.3.1 https://forge.etsi.org/rep/nfv/SOL002-SOL003/-/blob/v5.2.1/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml?ref_type=heads#L330
- POST Terminate a vnfInstance resource defined in 5.4.8.3.1 https://forge.etsi.org/rep/nfv/SOL002-SOL003/-/blob/v5.2.1/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml?ref_type=heads#L451
- POST Heal a vnfInstance resource defined in in 5.4.9.3.1 https://forge.etsi.org/rep/nfv/SOL002-SOL003/-/blob/v5.2.1/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml?ref_type=heads#L491
- POST Change External VNF Connectivity resource defined in 5.4.11.3.1 https://forge.etsi.org/rep/nfv/SOL002-SOL003/-/blob/v5.2.1/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml?ref_type=heads#L571
- Post Retry operation task resource defined in 5.4.14.3.1 https://forge.etsi.org/rep/nfv/SOL002-SOL003/-/blob/v5.2.1/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml?ref_type=heads#L732
- Post Rollback operation task resource defined in 5.4.15.3.1 https://forge.etsi.org/rep/nfv/SOL002-SOL003/-/blob/v5.2.1/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml?ref_type=heads#L772
- POST Create a new subscription resource defined in 5.4.18.3.1 https://forge.etsi.org/rep/nfv/SOL002-SOL003/-/blob/v5.2.1/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml?ref_type=heads#L925
- GET Individual Subscription resource defined in 5.4.18.3.2 https://forge.etsi.org/rep/nfv/SOL002-SOL003/-/blob/v5.2.1/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml?ref_type=heads#L890
- GET Show subscription resource defined in 5.4.19.3.2 https://forge.etsi.org/rep/nfv/SOL002-SOL003/-/blob/v5.2.1/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml?ref_type=heads#L962
- DELETE an individual subscription resource defined in 5.4.19.3.5 https://forge.etsi.org/rep/nfv/SOL002-SOL003/-/blob/v5.2.1/src/SOL002/VNFLifecycleManagement/VNFLifecycleManagement.yaml?ref_type=heads#L993