Skip to content

Add security scheme descriptions to Azure Core data-plane playground sample #4547

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Copilot wants to merge 7 commits into
base: main
Choose a base branch
from
+44 −5
Open

Add security scheme descriptions to Azure Core data-plane playground sample #4547

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
ca88c54
Initial plan
Copilot Jun 3, 2026
236ecf0
Add auth scheme descriptions to data-plane widget-manager sample
Copilot Jun 3, 2026
6de4332
Use doc comments for widget-manager auth scheme descriptions
Copilot Jun 3, 2026
3682835
Merge branch 'main' into copilot/bugfix-security-scheme-descriptions
timotheeguerin Jun 18, 2026
9986be3
Regenerate widget-manager sample output and format snapshot
Copilot Jun 18, 2026
722a4df
Format widget-manager auth model declaration
Copilot Jun 23, 2026
c38bac5
Merge branch 'main' into copilot/bugfix-security-scheme-descriptions
timotheeguerin Jun 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion packages/samples/specs/data-plane/widget-manager/main.tsp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,22 @@ using Azure.Core.Traits;

@service(#{ title: "Contoso Widget Manager" })
@versioned(Contoso.WidgetManager.Versions)
@useAuth(ApiKeyAuth<ApiKeyLocation.header, "X-Key">)
@useAuth(WidgetManagerApiKeyAuth | WidgetManagerOauth2Auth)
namespace Contoso.WidgetManager;

/** Authenticate requests with an API key in the X-Key header. */
model WidgetManagerApiKeyAuth is ApiKeyAuth<ApiKeyLocation.header, "X-Key">;

/** Authenticate requests with OAuth2 using the widget service scope. */
model WidgetManagerOauth2Auth
is OAuth2Auth<[
{
type: OAuth2FlowType.implicit;
authorizationUrl: "https://login.contoso.com/common/oauth2/v2.0/authorize";
scopes: ["https://widget.contoso.com/.default"];
}
]>;

@doc("The Contoso Widget Manager service version.")
enum Versions {
@doc("Version 2022-08-31")
Expand Down
19 changes: 17 additions & 2 deletions ...ure/core/data-plane/widget-manager/@azure-tools/typespec-autorest/2022-08-31/openapi.json
View file
Open in desktop
Comment thread
timotheeguerin marked this conversation as resolved.
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,29 @@
],
"security": [
{
"ApiKeyAuth": []
"WidgetManagerApiKeyAuth": []
},
{
"WidgetManagerOauth2Auth": [
"https://widget.contoso.com/.default"
]
}
],
"securityDefinitions": {
"ApiKeyAuth": {
"WidgetManagerApiKeyAuth": {
"type": "apiKey",
"description": "Authenticate requests with an API key in the X-Key header.",
"name": "X-Key",
"in": "header"
},
"WidgetManagerOauth2Auth": {
"type": "oauth2",
"description": "Authenticate requests with OAuth2 using the widget service scope.",
"flow": "implicit",
"authorizationUrl": "https://login.contoso.com/common/oauth2/v2.0/authorize",
"scopes": {
"https://widget.contoso.com/.default": ""
}
}
},
"tags": [],
Expand Down
15 changes: 13 additions & 2 deletions ...st/output/azure/core/data-plane/widget-manager/@typespec/openapi3/openapi.2022-08-31.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1271,7 +1271,9 @@ paths:
schema:
$ref: '#/components/schemas/WidgetRepairRequest'
security:
- ApiKeyAuth: []
- WidgetManagerApiKeyAuth: []
- WidgetManagerOauth2Auth:
- https://widget.contoso.com/.default
components:
parameters:
Azure.Core.ClientRequestIdHeader:
Expand Down Expand Up @@ -1684,7 +1686,16 @@ components:
- SentToManufacturer
description: The repair state of a widget.
securitySchemes:
ApiKeyAuth:
WidgetManagerApiKeyAuth:
Comment thread
timotheeguerin marked this conversation as resolved.
type: apiKey
in: header
name: X-Key
description: Authenticate requests with an API key in the X-Key header.
WidgetManagerOauth2Auth:
type: oauth2
flows:
implicit:
authorizationUrl: https://login.contoso.com/common/oauth2/v2.0/authorize
scopes:
https://widget.contoso.com/.default: ''
description: Authenticate requests with OAuth2 using the widget service scope.
Loading