Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

False positivizes and undetailed errors for RequiredStatusChange

Open
#288 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
30/100
Issue type
Bug
Clarity
Needs clarification
Activity status
Stale
Tech stack
csharp, openapi
Domain
cli, tooling

Research direction

Start by reproducing the RequiredStatusChange entries shown in breaking-changes.json through the openapi-diff command-line tool, then trace the comparison logic that produces those messages. Done means the reported required-value changes are accurate and the listed false positives no longer appear.

Written by the indexing model from the issue text.

Description

I'm working on https://github.com/Azure/azure-rest-api-specs-pr/pull/15631 and there are some required differences reported between the old API version and the generated from TypeSpec version regarding properties. The errors are not very accurate. They should say what required values changes. Many look to be false positives.

~/ms/azure-rest-api-specs-pr> open breaking-changes.json | where code == RequiredStatusChange | select message old.path | to md
message old_path
The 'required' status changed from the old version('False') to the new version('True'). definitions.PrivateCloudList.properties New list has "required": ["value"]
The 'required' status changed from the old version('True') to the new version('False'). definitions.PrivateCloud.properties Neither has required.
The 'required' status changed from the old version('True') to the new version('False'). definitions.ManagementCluster.properties Neither has required.
The 'required' status changed from the old version('False') to the new version('True'). definitions.PrivateCloudIdentity.properties
The 'required' status changed from the old version('False') to the new version('True'). definitions.ClusterList.properties
The 'required' status changed from the old version('True') to the new version('False'). definitions.Cluster.properties Neither has required.
The 'required' status changed from the old version('False') to the new version('True'). definitions.DatastoreList.properties
The 'required' status changed from the old version('False') to the new version('True'). definitions.HcxEnterpriseSiteList.properties
The 'required' status changed from the old version('False') to the new version('True'). definitions.ExpressRouteAuthorizationList.properties
The 'required' status changed from the old version('False') to the new version('True'). definitions.GlobalReachConnectionList.properties
The 'required' status changed from the old version('False') to the new version('True'). definitions.WorkloadNetworkList.properties
The 'required' status changed from the old version('False') to the new version('True'). definitions.WorkloadNetworkSegmentsList.properties
The 'required' status changed from the old version('False') to the new version('True'). definitions.WorkloadNetworkDhcpList.properties
The 'required' status changed from the old version('False') to the new version('True'). definitions.WorkloadNetworkGatewayList.properties
The 'required' status changed from the old version('False') to the new version('True'). definitions.WorkloadNetworkPortMirroringList.properties
The 'required' status changed from the old version('False') to the new version('True'). definitions.WorkloadNetworkVMGroupsList.properties
The 'required' status changed from the old version('False') to the new version('True'). definitions.WorkloadNetworkVirtualMachinesList.properties
The 'required' status changed from the old version('False') to the new version('True'). definitions.WorkloadNetworkDnsServicesList.properties
The 'required' status changed from the old version('False') to the new version('True'). definitions.WorkloadNetworkDnsZonesList.properties
The 'required' status changed from the old version('False') to the new version('True'). definitions.WorkloadNetworkPublicIPsList.properties
The 'required' status changed from the old version('False') to the new version('True'). definitions.CloudLinkList.properties
The 'required' status changed from the old version('False') to the new version('True'). definitions.AddonList.properties
The 'required' status changed from the old version('False') to the new version('True'). definitions.VirtualMachinesList.properties
The 'required' status changed from the old version('False') to the new version('True'). definitions.PlacementPoliciesList.properties
The 'required' status changed from the old version('False') to the new version('True'). definitions.ScriptPackagesList.properties
The 'required' status changed from the old version('False') to the new version('True'). definitions.ScriptCmdletsList.properties
The 'required' status changed from the old version('False') to the new version('True'). definitions.ScriptExecutionsList.properties
The 'required' status changed from the old version('False') to the new version('True'). definitions.TrackedResource.properties
Dominant language
C#
Stars
290
Forks
50
Avg merge
2d 21h
Merged PRs (30d)
10

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.

More from Azure/openapi-diff

All issues in Azure/openapi-diff

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.