No difference reported for required property changed to optional
Open
bug
- Dominant language
- C#
- Stars
- 290
- Forks
- 50
- Avg merge
- 5d 13h
- Merged PRs (30d)
- 5
Description
Openapi-diff does not report a required property that was changed to optional -- removed from the schema "required" array. Changing a required property to optional in an output schema could cause breaking changes if a client relies on a property always being present in a response (because it was marked "required") and the property is then omitted from some responses in the new version.
Contributor guide
Research direction
Start at the command-line tool's OpenAPI schema comparison and trace how the schema "required" array is handled. Reproduce the reported transition from required to optional in two specifications, then verify that the tool reports the change as breaking.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp
- Domain
- api, cli
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100