Azure / Azure/azure-rest-api-specs

[BUG]Description for filter parameter among Role Assignments List Operations is incorrect

Open
#28,255 5 comments 0 reactions 0 assignees View on GitHub
Authorization bug Mgmt Service Attention
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/main/specification/authorization/resource-manager/Microsoft.Authorization/stable/2022-04-01/authorization-RoleAssignmentsCalls.json#L684

### API Spec version

2022-04-01

### Describe the bug

The format mentioned for parameter filter in the description `principalId eq {id}` is actually not supported, which would made confusions to the users.
The correct format should be `principalId eq '{id}'`.

### Expected behavior

Update the words `$filter=principalId eq {id}` to `$filter=principalId eq '{id}'` in the description.

### Actual behavior

![image](https://github.com/Azure/azure-rest-api-specs/assets/119990644/555186ce-24a3-43a7-bf13-69b7261e2f1d)

### Reproduction Steps

Call Role Assignments List Operations with parameter `$filter` in format `principalId eq {id}`, returned with error `The filter 'principalId eq xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' is not supported. Supported filters are either 'atScope()' or 'principalId eq '{value}' or assignedTo('{value}')'.`

### Environment

_No response_

Contributor guide

Open the contributing guide

Research direction

Open specification/authorization/resource-manager/Microsoft.Authorization/stable/2022-04-01/authorization-RoleAssignmentsCalls.json at line 684 and inspect the filter parameter description. Compare it with the supported filter format shown in the issue; it is complete when the description uses the quoted principal ID form and the spec diff contains only that wording correction.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api, documentation
Issue type
Bug
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.