Azure / Azure/azure-rest-api-specs

[BUG] ApiManagement Group propery: displayName is incorrect while getting it from user's group

Open
#35,705 1 comment 0 reactions 0 assignees View on GitHub
bug
Dominant language
TypeSpec
Stars
3.1k
Forks
5.9k
Avg merge
3d 2h
Merged PRs (30d)
424

Description

### API Spec link

https://github.com/Azure/azure-rest-api-specs/blob/d956707fc8584c02bcb349291af5f1e9e3bba4c8/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/apimusers.json#L70

### API Spec version

All

### Describe the bug

Get the users from a apim service and set the `expandGroups` to `true` will get the group data together.
In this case the group's name is returned in `name` property, not in `displayName`.
The spec definition is `displayName`: https://github.com/Azure/azure-rest-api-specs/blob/d956707fc8584c02bcb349291af5f1e9e3bba4c8/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/definitions.json#L3296

Image

### Expected behavior

"displayName"

### Actual behavior

"name"

### Reproduction Steps

GET /subscriptions/<>/resourceGroups/<>/providers/Microsoft.ApiManagement/service/<>/users?expandGroups=true&api-version=2024-05-01

### Environment

_No response_

Contributor guide

Open the contributing guide

Research direction

Review the API definition in definitions.json at the linked line and the user-group schema in apimusers.json at line 70. Reproduce the GET request with expandGroups=true, then verify that the returned group value is represented as displayName rather than name in the 2024-05-01 specification.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.