Update service authentication OAuth2 flow scopes to be object with description.
#849
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
timotheeguerin
requested review from
allenjzhang,
bterlson,
daviwil,
markcowl and
nguerrera
as code owners
|
You can try these changes at https://cadlplayground.z22.web.core.windows.net/prs/849/ |
markcowl
approved these changes
Aug 17, 2022
steverice
added a commit
to pinterest/typespec
that referenced
this pull request
Jan 29, 2025
This makes a small change to the code introduced in microsoft#849 to allow for models to be used as OAuth scopes. Without this check, an object like `{value: "foo", description: "bar"}` gets wrapped in an additional `value` key. When the OpenAPI3 emitter tries to print out the `securitySchemes`, it sees `{value: {...}}` and produces a scope with value `[object Object]` and no description. Here instead we check for an object and prevent the wrapping.
steverice
added a commit
to pinterest/typespec
that referenced
this pull request
Dec 2, 2025
This makes a small change to the code introduced in microsoft#849 to allow for models to be used as OAuth scopes. Without this check, an object like `{value: "foo", description: "bar"}` gets wrapped in an additional `value` key. When the OpenAPI3 emitter tries to print out the `securitySchemes`, it sees `{value: {...}}` and produces a scope with value `[object Object]` and no description. This also introduces a base `SecurityScheme` model that allows for more specific type checking on the `@useAuth` decorator.
steverice
added a commit
to pinterest/typespec
that referenced
this pull request
Dec 2, 2025
This makes a small change to the code introduced in microsoft#849 to allow for models to be used as OAuth scopes. Without this check, an object like `{value: "foo", description: "bar"}` gets wrapped in an additional `value` key. When the OpenAPI3 emitter tries to print out the `securitySchemes`, it sees `{value: {...}}` and produces a scope with value `[object Object]` and no description. This also introduces a base `SecurityScheme` model that allows for more specific type checking on the `@useAuth` decorator. We need to remove an `openapi3` test that checks for an error when providing an unsupported auth type. Now the compiler enforces that the auth type is `AuthType`, and `openapi3` supports all of the types in `AuthType`, it should not be possible to trigger this condition in TSP.
steverice
added a commit
to pinterest/typespec
that referenced
this pull request
Dec 3, 2025
This makes a small change to the code introduced in microsoft#849 to allow for models to be used as OAuth scopes. Without this check, an object like `{value: "foo", description: "bar"}` gets wrapped in an additional `value` key. When the OpenAPI3 emitter tries to print out the `securitySchemes`, it sees `{value: {...}}` and produces a scope with value `[object Object]` and no description.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Change the scopes from
string[]to{value: string, description?: string}. There is no way yet to set the description in Cadl but this unblock issue with the Arm generated swagger specs.https://github.com/Azure/cadl-azure/pull/1855
I think to allow description in the cadl document for scopes the flow should allow taking an enum instead of tuple of string(either one) that way you can have things like