Skip to content

[OpenAPI] Ignore getCustomFieldNames() method from default Jackson serialization - #102

Merged
newtork merged 6 commits into
mainfrom
openapi-ignore-custom-fields-getter
Nov 2, 2023
Merged

newtork merged 6 commits into
mainfrom
openapi-ignore-custom-fields-getter

Conversation

@newtork

@newtork newtork commented Oct 23, 2023 •

Copy link
Copy Markdown
Contributor

(low priority)

We had a customer issue in v4, where the complaint was default new ObjectMapper() was serializing a customFieldNames : [] for every OpenAPI entity. For them it was unexpected and faulty behavior.

While the cause is based on improper SAP Cloud SDK class usage, still we could have a little house-keeping here.

Needless to say, I have no personal stakes here. If you decline the change; fine for me :)

@Johannes-Schneider Johannes-Schneider 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.

Changes LGTM - they are also simple enough to "just ship it" IMO.
Do we need a release note?


How are we dealing with backporting changes? Since this change is so simple (and we do have a customer issue), backporting shouldn't be a lot of effort. But not sure whether we already had a team decision for that.

@newtork

newtork commented Oct 24, 2023

Copy link
Copy Markdown
Contributor Author

How are we dealing with backporting changes?

Of course we can backport, but since this is not a "real" bug, I felt it fits better the next generation SDK ;)
Not aligned yet with PO.

Not sure whether we already had a team decision for that.

There was no team communication on this yet.

@jjtang1985

jjtang1985 commented Oct 24, 2023 •

Copy link
Copy Markdown
Contributor

How are we dealing with backporting changes?

I dont have strong opinion here.
In general, back porting is only needed for urgent bugs/features, or very small PRs.

Here some bullet points of this issue:

  1. This is not a bug, but due to unexpected use cases. I would hope that they use the documented features of the SDK.
  2. The runtime behaviour changes are triggered by 1 (maybe together with other dependency updates), instead of SDK source code changes.
  3. Workaround is provided, so they can continue with the current unexpected use cases. I've just asked for their feedback.
  4. As the consumer used Business Logging service, instead of the generator, I guess this change will not help them directly, unless we also update the Business Logging clients.

I feel maybe we can wait for their response first.
If the workaround does not help, then we take some actions?

Do we need a release note?

As an improvement, I guess we need some release notes.

@Johannes-Schneider

Copy link
Copy Markdown
Contributor

I dont have strong opinion here.

Neither do I.
I just thought it might fit quite nicely as we are planning to do a v4 release anyways.

As the consumer used Business Logging service, instead of the generator, I guess this change will not help them directly, unless we also update the Business Logging clients.

That's a very good point.

I feel maybe we can wait for their response first.
If the workaround does not help, then we take some actions?

Sounds like a plan. 👍

@newtork

newtork commented Oct 24, 2023

Copy link
Copy Markdown
Contributor Author

This is why I phrased the PR as house-keeping, not as bug fix :)

@Johannes-Schneider

Copy link
Copy Markdown
Contributor

@newtork would you mind adding a tiny release note so that this PR is ready to be merged?

@Johannes-Schneider Johannes-Schneider 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.

LGTM

@newtork
newtork merged commit 7bcd838 into main Nov 2, 2023
@newtork
newtork deleted the openapi-ignore-custom-fields-getter branch November 2, 2023 14:07
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.

3 participants