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.

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

Provide meaningful error message for bom and vex exceeding Jackson's character limit #3558

Merged
merged 1 commit into from
Mar 17, 2024

Conversation

nscuro
Copy link
Member

@nscuro nscuro commented Mar 17, 2024

Description

Provides a meaningful error message for bom and vex exceeding Jackson's character limit.

Also document the limitation in the OpenAPI spec of the respective PUT methods that accept JSON payloads.

Addressed Issue

Fixes #3182

Additional Details

Example response for the PUT /api/v1/bom endpoint:

{
  "status": 400,
  "title": "The provided JSON payload could not be mapped",
  "detail": "The BOM is too large to be transmitted safely via Base64 encoded JSON value. Please use the \"POST /api/v1/bom\" endpoint with Content-Type \"multipart/form-data\" instead. Original cause: String length (20000001) exceeds the maximum length (20000000) (through reference chain: org.dependencytrack.resources.v1.vo.BomSubmitRequest[\"bom\"])"
}

Checklist

  • I have read and understand the contributing guidelines
  • This PR fixes a defect, and I have provided tests to verify that the fix is effective
  • This PR implements an enhancement, and I have provided tests to verify that it works as intended
  • This PR introduces changes to the database model, and I have added corresponding update logic
  • This PR introduces new or alters existing behavior, and I have updated the documentation accordingly

@nscuro nscuro added the defect Something isn't working label Mar 17, 2024
@nscuro nscuro added this to the 4.11 milestone Mar 17, 2024
…n's character limit

Also document the limitation in the OpenAPI spec of the respective `PUT` methods that accept JSON payloads.

Fixes DependencyTrack#3182

Signed-off-by: nscuro <[email protected]>
Copy link

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
+0.00% (target: -1.00%) 90.91% (target: 70.00%)
Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (753924d) 21517 15938 74.07%
Head commit (a6804a4) 21539 (+22) 15955 (+17) 74.07% (+0.00%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details
Coverable lines Covered lines Diff coverage
Pull request (#3558) 22 20 90.91%

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

You may notice some variations in coverage metrics with the latest Coverage engine update. For more details, visit the documentation

@nscuro nscuro merged commit eb5d251 into DependencyTrack:master Mar 17, 2024
12 checks passed
@nscuro nscuro deleted the issue-3182 branch March 17, 2024 19:52
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 17, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
defect Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Increase allowed BOM size for uploads
1 participant