Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(api): add OpenAPI docs for /vulnerabilities #2202

Merged
merged 2 commits into from
Dec 6, 2023
Merged

docs(api): add OpenAPI docs for /vulnerabilities #2202

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
27dc3d8
docs(api): add OpenAPI docs for releases
GMishx Nov 17, 2023
8b5428d
docs(api): add OpenAPI docs for /vulnerabilities
GMishx Nov 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions rest/resource-server/src/docs/asciidoc/releases.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,6 +257,20 @@ include::{snippets}/should_document_get_release_attachment_bundle/curl-request.a
===== Example response
include::{snippets}/should_document_get_release_attachment_bundle/http-response.adoc[]

[[resources-release-external-id]]
==== Get releases by external IDs

A `GET` request will allow you to get releases by external IDs.
Put the external ID as query parameter and its value as parameter's value.

===== Example request

include::{snippets}/should_document_get_releases_by_externalIds/curl-request.adoc[]

===== Example response

include::{snippets}/should_document_get_releases_by_externalIds/http-response.adoc[]

[[resources-release-attachment-delete]]
==== Delete attachments

Expand Down
54 changes: 50 additions & 4 deletions ...erver/src/main/java/org/eclipse/sw360/rest/resourceserver/core/JacksonCustomizations.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -1474,7 +1475,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
Expand Down Expand Up @@ -1803,7 +1831,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 {
}
Expand Down Expand Up @@ -1876,7 +1910,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 {
}
Expand All @@ -1886,7 +1928,11 @@ public static abstract class ReleaseVulnerabilityRelationMixin extends ReleaseVu
"setCheckedBy",
"setCheckedOn",
"setComment",
"setVerificationState"
"setVerificationState",
"checkedByIsSet",
"checkedOnIsSet",
"commentIsSet",
"verificationStateIsSet"
})
public static abstract class VerificationStateInfoMixin extends VerificationStateInfo {
}
Expand Down
Loading