Azure / Azure/azure-rest-api-specs
[bug][network] swagger definition doesn't follow server behavior
Nobody has claimed this yet.
- Dominant language
- TypeSpec
- Stars
- 3.1k
- Forks
- 6k
- Avg merge
- 2d 21h
- Merged PRs (30d)
- 432
Description
Its real service response is:
{
"up": 1,
"down": 1,
"loadBalancerBackendAddresses": [
{
"ipAddress": "<REDACTED>",
"networkInterfaceIPConfigurationId": "/subscriptions/<REDACTED>/resourceGroups/<REDACTED>/providers/Microsoft.Network/networkInterfaces/<REDACTED>/ipConfigurations/sslvpn",
"state": "Up",
"reason": "Up_Probe_Success"
},
{
"ipAddress": "<REDACTED>",
"networkInterfaceIPConfigurationId": "/subscriptions/<REDACTED>/resourceGroups/<REDACTED>/providers/Microsoft.Network/networkInterfaces/<REDACTED>/ipConfigurations/failover",
"state": "Down",
"reason": "Down_Probe_TcpProbeTimeout"
}
]
}
We can see that for networkInterfaceIPConfigurationId, its swagger definition is object however the real response is string which doesn't correspond.
Expected behavior
Swagger definition shall follow real service behavior.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open specification/network/resource-manager/Microsoft.Network/stable/2024-05-01/loadBalancer.json and compare the response definition at lines 1464-1536 with the networkInterfaceIPConfigurationId definition at lines 2842-2844. Verify the service response shape shown in the issue, then update the specification so the schema matches it and confirm the API specification remains valid.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100