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

Fix OpenAPI types of UNIX timestamp fields #3731

Merged
merged 1 commit into from
May 18, 2024

Conversation

nscuro
Copy link
Member

@nscuro nscuro commented May 18, 2024

Description

Fields of type Date that are not explicitly serialized with Iso8601DateSerializer are automatically serialized as UNIX epoch timestamp in milliseconds. However the OpenAPI spec declared them to be of type string in date-time format, which is incorrect.

Instead of changing the field's actual type, causing a breaking change, provide a type hint to the OpenAPI generator.

Addressed Issue

Fixes #1276
Fixes #2591

Additional Details

image

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

Fields of type `Date` that are not explicitly serialized with `Iso8601DateSerializer` are automatically serialized as UNIX epoch timestamp in milliseconds. However the OpenAPI spec declared them to be of type `string` in `date-time` format, which is incorrect.

Instead of changing the field's actual type, causing a breaking change, provide a type hint to the OpenAPI generator.

Fixes DependencyTrack#1276
Fixes DependencyTrack#2591

Signed-off-by: nscuro <nscuro@protonmail.com>
@nscuro nscuro added defect Something isn't working api docs labels May 18, 2024
@nscuro nscuro added this to the 4.12 milestone May 18, 2024
Copy link

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
+0.00% (target: -1.00%) (target: 70.00%)
Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (7573f39) 21648 16402 75.77%
Head commit (a7119e8) 21648 (+0) 16402 (+0) 75.77% (+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 (#3731) 0 0 ∅ (not applicable)

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

Codacy will stop sending the deprecated coverage status from June 5th, 2024. Learn more

@nscuro nscuro merged commit 2980188 into DependencyTrack:master May 18, 2024
12 checks passed
@nscuro nscuro deleted the openapi-v3 branch May 18, 2024 10:21
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 18, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
api docs defect Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

LastBomImport incorrect type from api REST API - date type mismatch
1 participant