microsoft / microsoft/OpenAPI.NET.OData

The default for UseStringArrayForQueryOptionsSchema should be false

Open
#614 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

priority:p1 type:bug type:regression
Dominant language
C#
Stars
240
Forks
70
Avg merge
7h 59m
Merged PRs (30d)
13

Description

https://github.com/microsoft/OpenAPI.NET.OData/blob/087438bc4610dc9aa3850707d0792054d2675a70/src/Microsoft.OpenApi.OData.Reader/OpenApiConvertSettings.cs#L334

Added in #499

Setting the default to true effectively changed every conversion from emitting array of enum values to arrays of strings silently.
This is a strong behaviour change, and the default should have been false.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open src/Microsoft.OpenApi.OData.Reader/OpenApiConvertSettings.cs at line 334 and review the setting introduced by #499. Change its default as requested, then verify that conversion behavior no longer silently changes from enum arrays to string arrays.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
api
Issue type
Bug
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.