Skip to content

Remove @JsonTypeName from Java POJOs - #14842

Open
bernie-schelberg-mywave wants to merge 4 commits into
OpenAPITools:masterfrom
bernie-schelberg-mywave:remove-json-type-name-java-1
Open

Remove @JsonTypeName from Java POJOs#14842
bernie-schelberg-mywave wants to merge 4 commits into
OpenAPITools:masterfrom
bernie-schelberg-mywave:remove-json-type-name-java-1

Conversation

@bernie-schelberg-mywave

Copy link
Copy Markdown
Contributor

Some other changes that I'm working on affect the behaviour of @JsonTypeName annotations in the Java pojo models. After doing some investigation, I concluded that those annotations are unnecessary (confirmed by this stackoverflow answer). @JsonTypeName is unnecessary when logical type names are specified within @JsonSubTypes, as is the case in the code generated from this project. As you can see from the generated samples, @JsonTypeName is also being added to classes that aren't a subclass of another model class, and @JsonTypeName is pointless in these cases as far as I know.

I created this PR as a separate change to limit the scope of changes. It's already large because of the number of samples affected. Removing the import of JsonTypeName is coming in separate PRs, as is removing the annotation from the Spring template.

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    For Windows users, please run the script in Git BASH.
  • In case you are adding a new generator, run the following additional script :
    ./bin/utils/ensure-up-to-date.sh
    
    Commit all changed files.
  • File the PR against the correct branch: master (6.3.0) (minor release - breaking changes with fallbacks), 7.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10)

@bernie-schelberg-mywave

Copy link
Copy Markdown
Contributor Author

I created another PR, #14852 which combines this change with the removal of @JsonTypeName from the JavaSpring template. This one can be closed if the other is accepted. For now I'll leave this one open for the purpose of reviewing the changes in isolation.

@welshm welshm left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me, but affects more than spring.

I think @borsch and @wing328 should probably also take a quick look!

Thank you for investigating and adding the tests to validate behaviour 🎉

private final ObjectMapper objectMapper = new ObjectMapper();

@Test
public void shouldSerializeAndDeserializeModel() throws JsonProcessingException {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice test!

*/
@Test
public void testSpecialCatAllOf() {
// TODO: test SpecialCatAllOf

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding before merging?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't plan to. It was created by the generator. It looks like most of the generated tests don't have any implementations in them. Is there anything that you think I should do with it?

import static org.hamcrest.CoreMatchers.is;
import static org.hamcrest.MatcherAssert.assertThat;

public class SpecialCatJacksonTest {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This test is in the apache-httpclient - probably fine, but the tests here are not apache client specific

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right, I'm still learning my way around the samples... I moved it into the java/native sample project. Is that the best place for it?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think java/native makes sense since it impacts all of Java

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants