docs(api): add OpenAPI docs for /vulnerabilities

1. Add OpenAPI docs for the `/vulnerabilities` endpoints. 2. Replace deprecated exception `HttpMessageNotReadableException` with `HttpClientErrorException`. Signed-off-by: Gaurav Mishra <gmishx@gmail.com>
eclipse-sw360 · Nov 17, 2023 · a3cae67 · a3cae67
1 parent be126e7
commit a3cae67
Show file tree

Hide file tree

Showing 2 changed files with 212 additions and 43 deletions.
diff --git a/...erver/src/main/java/org/eclipse/sw360/rest/resourceserver/core/JacksonCustomizations.java b/...erver/src/main/java/org/eclipse/sw360/rest/resourceserver/core/JacksonCustomizations.java
@@ -139,6 +139,7 @@ public Sw360Module() {
                     .replaceWithClass(Vulnerability.class, VulnerabilityMixin.class)
                     .replaceWithClass(VulnerabilityState.class, VulnerabilityStateMixin.class)
                     .replaceWithClass(ReleaseVulnerabilityRelationDTO.class, ReleaseVulnerabilityRelationDTOMixin.class)
+                    .replaceWithClass(VendorAdvisory.class, VendorAdvisoryMixin.class)
                     .replaceWithClass(VulnerabilityDTO.class, VulnerabilityDTOMixin.class)
                     .replaceWithClass(VulnerabilityApiDTO.class, VulnerabilityApiDTOMixin.class)
                     .replaceWithClass(EccInformation.class, EccInformationMixin.class)
@@ -1473,7 +1474,34 @@ static abstract class VulnerabilityMixin extends Vulnerability {
                 "setAccess",
                 "accessSize",
                 "releasesSize",
-                "setReleases"
+                "setReleases",
+                "descriptionIsSet",
+                "idIsSet",
+                "revisionIsSet",
+                "typeIsSet",
+                "releasesIsSet",
+                "externalIdIsSet",
+                "titleIsSet",
+                "publishDateIsSet",
+                "lastExternalUpdateIsSet",
+                "priorityIsSet",
+                "actionIsSet",
+                "impactIsSet",
+                "legalNoticeIsSet",
+                "cveReferencesIsSet",
+                "referencesIsSet",
+                "lastUpdateDateIsSet",
+                "priorityTextIsSet",
+                "assignedExtComponentIdsIsSet",
+                "vendorAdvisoriesIsSet",
+                "extendedDescriptionIsSet",
+                "cvssIsSet",
+                "isSetCvssIsSet",
+                "cvssTimeIsSet",
+                "vulnerableConfigurationIsSet",
+                "accessIsSet",
+                "cweIsSet",
+                "cveFurtherMetaDataPerSourceIsSet"
         })
         public static abstract class VulnerabilityApiDTOMixin extends VulnerabilityApiDTO {
             @Override
@@ -1802,7 +1830,13 @@ public static abstract class CVEReferenceMixin extends CVEReference {
                 "setName",
                 "setVendor",
                 "setUrl",
-                "type"
+                "type",
+                "urlIsSet",
+                "nameIsSet",
+                "idIsSet",
+                "revisionIsSet",
+                "typeIsSet",
+                "vendorIsSet"
         })
         public static abstract class VendorAdvisoryMixin extends VendorAdvisory {
         }
@@ -1875,7 +1909,15 @@ public static abstract class VulnerabilityMixinForCreateUpdate extends Vulnerabi
                 "setMatchedBy",
                 "setUsedNeedle",
                 "setReleaseId",
-                "setSpdxId"
+                "setSpdxId",
+                "idIsSet",
+                "revisionIsSet",
+                "typeIsSet",
+                "releaseIdIsSet",
+                "matchedByIsSet",
+                "usedNeedleIsSet",
+                "vulnerabilityIdIsSet",
+                "verificationStateInfoIsSet"
         })
         public static abstract class ReleaseVulnerabilityRelationMixin extends ReleaseVulnerabilityRelation {
         }
@@ -1885,7 +1927,11 @@ public static abstract class ReleaseVulnerabilityRelationMixin extends ReleaseVu
                 "setCheckedBy",
                 "setCheckedOn",
                 "setComment",
-                "setVerificationState"
+                "setVerificationState",
+                "checkedByIsSet",
+                "checkedOnIsSet",
+                "commentIsSet",
+                "verificationStateIsSet"
         })
         public static abstract class VerificationStateInfoMixin extends VerificationStateInfo {
         }