Azure / Azure/azure-rest-api-specs

Network Interfaces - Get Effective Route Table is misleading

Open
#9,589 4 comments 0 reactions 0 assignees View on GitHub
customer-reported Network - Virtual Network question Service Attention
Dominant language
TypeSpec
Stars
3.1k
Forks
5.9k
Avg merge
2d 22h
Merged PRs (30d)
444

Description

By looking at the docs [here](https://docs.microsoft.com/en-us/rest/api/virtualnetwork/networkinterfaces/geteffectiveroutetable), it seems that this api should return a route table, but instead it returns a list of [EffectiveRoutes](https://docs.microsoft.com/en-us/rest/api/virtualnetwork/networkinterfaces/geteffectiveroutetable#effectiveroute). I think the functionality is fine, but to me the naming is misleading. The documentation even furthers me thinking that it should be returning a route table (which is an existing, valid Azure construct): "Gets all route tables applied to a network interface."

Maybe something like "Get Effective Routes" instead?

I've opened [this issue](https://github.com/Azure/azure-sdk-for-python/issues/11634) in the python api.

Contributor guide

Open the contributing guide

Research direction

Start with the linked GetEffectiveRouteTable REST reference and its EffectiveRoute response definition. Review the operation name and description against the returned data; done means the specification and documentation consistently describe effective routes rather than route tables, without changing behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
azure, openapi
Domain
api, documentation, networking
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.