Azure / Azure/azure-rest-api-specs

Misleading description in AuthConfig.js of GlobalValidation.ExcludedPaths property.

Open
#36,453 0 comments 0 reactions 0 assignees View on GitHub
customer-reported question
Dominant language
TypeSpec
Stars
3.1k
Forks
5.9k
Avg merge
2d 22h
Merged PRs (30d)
444

Description

The [current description](https://github.com/Azure/azure-rest-api-specs/blob/48cba8646b6cb51ce77bd95a2a8c3dddca068459/specification/app/resource-manager/Microsoft.App/stable/2022-03-01/AuthConfigs.json#L331C10-L331C112) says:

> The paths for which unauthenticated flow would not be redirected to the login page.

However, that is only true if the `UnauthenticatedClientAction` property is set to `UnauthenticatedClientActionV2.RedirectToLoginPage`.

My experience is that a description like this would be more accurate:
> The paths for which unauthenticated flow would not take the UnauthenticatedClientAction

Raising this after being pointed here from https://github.com/Azure/azure-sdk-for-net/issues/51569

Contributor guide

Open the contributing guide

Research direction

Start with specification/app/resource-manager/Microsoft.App/stable/2022-03-01/AuthConfigs.json around line 331 and inspect the GlobalValidation.ExcludedPaths description alongside UnauthenticatedClientAction. Update the description so it accurately covers the configured unauthenticated action, then verify the generated AuthConfig.js description reflects the correction.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api
Issue type
Documentation
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.