Skip to content

Do not require JsonSubType annotation for sealed classes#2696

Merged
bnasslahsen merged 1 commit intospringdoc:mainfrom
sahil-ramagiri:sealed-classes
Feb 16, 2025
Merged

Do not require JsonSubType annotation for sealed classes#2696
bnasslahsen merged 1 commit intospringdoc:mainfrom
sahil-ramagiri:sealed-classes

Conversation

@sahil-ramagiri
Copy link
Copy Markdown
Contributor

@sahil-ramagiri sahil-ramagiri commented Sep 1, 2024

Description of Changes

  1. SpringDocSealedClassModule.java
    • Provides swagger and jackson with the ability to introspect annotations and resolve subclasses from the permits list of sealed classes.
    • Ensures that subclasses are correctly identified without the need for JsonSubType annotations.
  2. SpringDocConfiguration.java
    • Registers the new SpringDocSealedClassModule with objectmapper.
  3. API Tests 224, 225
    • Includes polymorphic deserialization tests to verify functionality without JsonSubType annotations.

Important Note

@bnasslahsen
Copy link
Copy Markdown
Collaborator

bnasslahsen commented Sep 24, 2024

@sahil-ramagiri,

Your PR is still in draft mode.
Are you willing to finish it, or we need to close it ?

@sahil-ramagiri
Copy link
Copy Markdown
Contributor Author

sahil-ramagiri commented Sep 24, 2024 •
edited
Loading

@sahil-ramagiri,

Your PR is still in draft mode. Are you willing to finish it, or we need to close it ?

@bnasslahsen This is dependent on this other issue in swagger-core. I am trying to get their attention but failing to do so. What do you suggest?

swagger-api/swagger-core#4744
swagger-api/swagger-core#4728

@bnasslahsen
Copy link
Copy Markdown
Collaborator

bnasslahsen commented Sep 24, 2024

@sahil-ramagiri,

Just try to ping them again, no worries

@bnasslahsen bnasslahsen changed the title Do not require JsonSubType annotation for sealed classes. Do not require JsonSubType annotation for sealed classes Oct 5, 2024
@bnasslahsen
Copy link
Copy Markdown
Collaborator

bnasslahsen commented Oct 6, 2024

i see

@sahil-ramagiri sahil-ramagiri marked this pull request as ready for review January 17, 2025 22:55
@sahil-ramagiri
Copy link
Copy Markdown
Contributor Author

sahil-ramagiri commented Jan 17, 2025

@bnasslahsen The latest release of swagger-core includes my fixes. This PR is finally ready to be merged. Please review.

bnasslahsen added a commit that referenced this pull request Feb 16, 2025
@bnasslahsen
Do not require JsonSubType annotation for sealed classes #2696
f4e632b
@bnasslahsen bnasslahsen merged commit 8f98a39 into springdoc:main Feb 16, 2025
@nandorholozsnyak nandorholozsnyak mentioned this pull request Mar 19, 2025
Closed
mpleine pushed a commit to mpleine/springdoc-openapi that referenced this pull request May 17, 2025
@bnasslahsen
Do not require JsonSubType annotation for sealed classes springdoc#2696
64a0e8d
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@sahil-ramagiri @bnasslahsen