setting all required fields as optional should not serialize "required" as an empty array

[ben-lc]

Expected Behavior

When fields are set as required on a schema and then set back as optional so that "required" field is empty, "required" should no be serialized in json or yaml, cause empty array is invalid for some openapi versions (cf: https://community.smartbear.com/discussions/swaggerostools/empty-array-in-required-field-in-schema-object/193184)

Actual Behavior

Required field is serialized as an empty array.

Steps to Reproduce the Problem

1. Create a new openapi spec
2. Create a new data type
3. Create an required property on the data type
4. Set previous property as not required

Specifications

• apicurio studio: 0.2.62.Final
• apicurio data models: 1.1.28

Cause

In apicurio-data-models, the ChangePropertyTypeCommand which is called when required field is changed on a property will create a new array to store required properties and will keep an empty array when all required properties are removed.

Proposed solution

Call parent.setRequiredProperties(null); to replace empty array by null so that "required" is not serialized when empty.

[ben-lc]

Hi @EricWittmann, I created PR Apicurio/apicurio-data-models#838 in apicurio-data-models to solve this issue.

[EricWittmann]

Interesting! Nice catch on this. I think we can go ahead with merging your PR, but for data models 2.0 I'm wondering if this logic should be captured in the data model serializer. I'll give it some thought...

[ben-lc]

I agree, it should be better to handle this at serialization level.

[EricWittmann]

FYI I merged the PR and am trying to release data-models. Having trouble, will keep working on it.

[EricWittmann]

OK release is done successfully.

[ben-lc]

Great thanks. Le jeu. 14 nov. 2024, 16:51, Eric Wittmann ***@***.***> a écrit :

…

OK release is done successfully. — Reply to this email directly, view it on GitHub <#2943 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AJCJX5YUCFLVXI4FPSREOSD2ATBJPAVCNFSM6AAAAABRUJBOF6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDINZWG43DONBUHE> . You are receiving this because you authored the thread.Message ID: ***@***.***>