Skip to content

fix: [OpenAPI] Correct @Nullable on inner enum fromValue(String) methods #746

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

Jump to bottom
Merged
newtork merged 3 commits into from
Mar 12, 2025
Merged

fix: [OpenAPI] Correct @Nullable on inner enum fromValue(String) methods #746

newtork merged 3 commits into from
Mar 12, 2025

Conversation

@newtork
Copy link
Contributor

@newtork newtork commented Mar 5, 2025 •
edited
Loading

Context

I've noticed the issue while working on this SAP/ai-sdk-java#370

Before

The following spec

  "components": {
    "schemas": {
      "Soda": {
        "type": "object",
        "properties": {
          "diet": {
            "type": "string",
            "enum": ["sugar", "zero", "light"],
            "nullable": true    // <-------
          },

evaluates to

public class Soda 
{
  public enum DietEnum {
    ...

    @JsonCreator
    @Nonnull public static DietEnum fromValue(@Nonnull final String value) {
      for (DietEnum b : DietEnum.values()) {
        if (b.value.equals(value)) {
          return b;
        }
      }
      return null; //  <------- WARNING: returning null on @Nonnull method
    }
  }

After

- @Nonnull
+ @Nullable
             public static DietEnum fromValue(@Nonnull final String value) {

Definition of Done

  • Functionality scope stated & covered
  • Tests cover the scope above
  • Error handling created / updated & covered by the tests above
  • Documentation updated
  • Release notes updated

@newtork newtork added please merge Request to merge a pull request please review Request to review a pull request labels Mar 5, 2025
@newtork newtork mentioned this pull request Mar 10, 2025
Merged
10 tasks
rpanackal
rpanackal approved these changes Mar 11, 2025
View reviewed changes
Copy link
Member

@rpanackal rpanackal left a comment •
edited
Loading

Choose a reason for hiding this comment

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

LGTM

@newtork newtork merged commit 144c7fd into main Mar 12, 2025
14 checks passed
@newtork newtork deleted the openapi/fix-nullable-innerenum branch March 12, 2025 10:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@rpanackal rpanackal rpanackal approved these changes

Assignees

No one assigned

Labels

please merge Request to merge a pull request please review Request to review a pull request

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@newtork @rpanackal @a-d