Azure / Azure/azure-rest-api-specs

[Resource] `/subscriptions/{subscriptionId}/locations`: Document lags behind swagger

Open
#22,399 1 comment 0 reactions 0 assignees View on GitHub
ARM Service Attention
Dominant language
TypeSpec
Stars
3.1k
Forks
5.9k
Avg merge
2d 22h
Merged PRs (30d)
444

Description

The latest stable API version for `/subscriptions/{subscriptionId}/locations` is `2021-01-01`:

https://github.com/Azure/azure-rest-api-specs/blob/e0a8a42064db5ad298a3f660805d65283c07aca2/specification/resources/resource-manager/Microsoft.Resources/stable/2021-01-01/subscriptions.json#L37

but the public document is still for `2020-01-01`:

https://learn.microsoft.com/en-us/rest/api/resources/subscriptions/list-locations

![image](https://user-images.githubusercontent.com/4003950/215940434-6bd841f0-d134-451a-8058-005dcdca249c.png)

which I think is generated from https://github.com/Azure/azure-rest-api-specs/blob/e0a8a42064db5ad298a3f660805d65283c07aca2/specification/resources/resource-manager/Microsoft.Resources/stable/2020-01-01/subscriptions.json#L62

This makes new query parameter `includeExtendedLocations` missing from the document:

https://github.com/Azure/azure-rest-api-specs/blob/e0a8a42064db5ad298a3f660805d65283c07aca2/specification/resources/resource-manager/Microsoft.Resources/stable/2021-01-01/subscriptions.json#L52-L59

Contributor guide

Open the contributing guide

Research direction

Compare the 2020-01-01 and 2021-01-01 subscriptions.json files linked in the issue, then check the linked public REST API documentation. Confirm how the document is generated and update the relevant source so the 2021-01-01 version and includeExtendedLocations parameter are reflected publicly.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.