Azure / Azure/azure-rest-api-specs

[Quota Service] Property name in swagger is case mismatch with the api implementation

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

Description

**Issue Description:**
The properties of `UsagesObject` are defined as camel case in [swagger](https://github.com/Azure/azure-rest-api-specs/blob/afa158ef56a05f6603924f4a493817cec332b113/specification/quota/resource-manager/Microsoft.Quota/stable/2023-02-01/quota.json#L863) like this:
```JSON
"UsagesObject": {
"description": "The resource usages value.",
"type": "object",
"properties": {
"value": {
"type": "integer",
"format": "int32",
"description": "The usages value."
},
"usagesType": {
"$ref": "#/definitions/UsagesTypes"
}
},
```
However, the response of the API from service is like below:
```JSON
{
"properties": {
"usages": {
"UsagesType": "Independent",
"Value": -1
},
"name": {
"value": "standardNDSFamily",
"localizedValue": "Standard NDS Family vCPUs"
},
"properties": {},
"unit": "Count",
"isQuotaApplicable": true
},...
}
```

**Impact:**
This issue blocks the customer to fetch these values through SDK.

Contributor guide

Open the contributing guide

Research direction

Start with the UsagesObject definition in specification/quota/resource-manager/Microsoft.Quota/stable/2023-02-01/quota.json at the linked line, then compare its property names with the service response shown in the issue. Update the specification to match the API's casing and verify that the schema represents the returned values correctly.

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
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.