False positivizes and undetailed errors for RequiredStatusChange
Ninguém assumiu esta issue ainda.
- Linguagem predominante
- C#
- Estrelas
- 290
- Forks
- 50
- Merge médio
- 5d 13h
- PRs com merge (30d)
- 5
Descrição
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 |
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Direção de pesquisa
Comece reproduzindo as entradas RequiredStatusChange mostradas em breaking-changes.json por meio da ferramenta de linha de comando openapi-diff e, em seguida, rastreie a lógica de comparação que produz essas mensagens. Está concluído quando as alterações de valores obrigatórios relatadas forem precisas e os falsos positivos listados não aparecerem mais.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- csharp, openapi
- Domínio
- cli, tooling
- Tipo de issue
- Bug
- Dificuldade
- 4/5
- Tempo estimado
- 3-5 dias
- Status de atividade
- Estagnada
- Clareza
- Precisa de esclarecimento
- Facilidade para iniciantes
- 30/100