Skip to content

Adds Constants for the Scheme and Bearer format types #745

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

Merged
merged 12 commits into from
Feb 22, 2022
Merged

Adds Constants for the Scheme and Bearer format types #745

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
7b2821e
Add enums to cater for multiple scheme and bearer formats
MaggieKimani1 Feb 16, 2022
8af1c19
Get the display name from the enum
MaggieKimani1 Feb 16, 2022
fc6f461
Refactor code
MaggieKimani1 Feb 16, 2022
5dc4d8a
Fix test
MaggieKimani1 Feb 16, 2022
4d84210
Merge branch 'vnext' into mk/feature/add-constants
MaggieKimani1 Feb 17, 2022
9720987
Add Jwt and Bearer constants and revert previous changes
MaggieKimani1 Feb 21, 2022
0390a81
Merge remote-tracking branch 'origin/mk/feature/add-constants' into m…
MaggieKimani1 Feb 21, 2022
15e7cc4
Merge branch 'vnext' into mk/feature/add-constants
MaggieKimani1 Feb 21, 2022
2b2bc25
Remove the OpenIdConnectUrl constant and replace it with the Bearer s…
MaggieKimani1 Feb 22, 2022
ad396b3
Merge remote-tracking branch 'origin/mk/feature/add-constants' into m…
MaggieKimani1 Feb 22, 2022
4fdfd70
Clean up solution file
MaggieKimani1 Feb 22, 2022
0f1350d
Revert
MaggieKimani1 Feb 22, 2022
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
10 changes: 3 additions & 7 deletions Microsoft.OpenApi.sln
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

Microsoft Visual Studio Solution File, Format Version 12.00
# Visual Studio Version 16
VisualStudioVersion = 16.0.29613.14
# Visual Studio Version 17
VisualStudioVersion = 17.1.32210.238
MinimumVisualStudioVersion = 10.0.40219.1
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.OpenApi", "src\Microsoft.OpenApi\Microsoft.OpenApi.csproj", "{A8E50143-69B2-472A-9D45-3F9A05D13202}"
EndProject
Expand All @@ -12,7 +12,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
readme.md = readme.md
EndProjectSection
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Microsoft.OpenApi.Workbench", "src\Microsoft.OpenApi.Workbench\Microsoft.OpenApi.Workbench.csproj", "{6A5E91E5-0441-46EE-AEB9-8334981B7F08}"
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.OpenApi.Workbench", "src\Microsoft.OpenApi.Workbench\Microsoft.OpenApi.Workbench.csproj", "{6A5E91E5-0441-46EE-AEB9-8334981B7F08}"
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.OpenApi.Readers", "src\Microsoft.OpenApi.Readers\Microsoft.OpenApi.Readers.csproj", "{79933258-0126-4382-8755-D50820ECC483}"
EndProject
Expand All @@ -38,10 +38,6 @@ Global
{A8E50143-69B2-472A-9D45-3F9A05D13202}.Debug|Any CPU.Build.0 = Debug|Any CPU
{A8E50143-69B2-472A-9D45-3F9A05D13202}.Release|Any CPU.ActiveCfg = Release|Any CPU
{A8E50143-69B2-472A-9D45-3F9A05D13202}.Release|Any CPU.Build.0 = Release|Any CPU
{6A5E91E5-0441-46EE-AEB9-8334981B7F08}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{6A5E91E5-0441-46EE-AEB9-8334981B7F08}.Debug|Any CPU.Build.0 = Debug|Any CPU
{6A5E91E5-0441-46EE-AEB9-8334981B7F08}.Release|Any CPU.ActiveCfg = Release|Any CPU
{6A5E91E5-0441-46EE-AEB9-8334981B7F08}.Release|Any CPU.Build.0 = Release|Any CPU
{79933258-0126-4382-8755-D50820ECC483}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{79933258-0126-4382-8755-D50820ECC483}.Debug|Any CPU.Build.0 = Debug|Any CPU
{79933258-0126-4382-8755-D50820ECC483}.Release|Any CPU.ActiveCfg = Release|Any CPU
Expand Down
2 changes: 1 addition & 1 deletion src/Microsoft.OpenApi.Readers/V2/OpenApiSecuritySchemeDeserializer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ internal static partial class OpenApiV2Deserializer
{
case "basic":
o.Type = SecuritySchemeType.Http;
o.Scheme = "basic";
o.Scheme = OpenApiConstants.Basic;
break;

case "apiKey":
Expand Down
10 changes: 10 additions & 0 deletions src/Microsoft.OpenApi/Models/OpenApiConstants.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -617,6 +617,16 @@ public static class OpenApiConstants
/// </summary>
public const string Basic = "basic";

/// <summary>
/// Field: Bearer
/// </summary>
public const string Bearer = "bearer";

/// <summary>
/// Field: JWT
/// </summary>
public const string Jwt = "JWT";

/// <summary>
/// Field: Consumes
/// </summary>
Expand Down
2 changes: 1 addition & 1 deletion test/Microsoft.OpenApi.Readers.Tests/V2Tests/OpenApiSecuritySchemeTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ public void ParseHttpSecuritySchemeShouldSucceed()
new OpenApiSecurityScheme
{
Type = SecuritySchemeType.Http,
Scheme = "basic"
Scheme = OpenApiConstants.Basic
});
}
}
Expand Down
6 changes: 3 additions & 3 deletions test/Microsoft.OpenApi.Readers.Tests/V3Tests/OpenApiSecuritySchemeTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ public void ParseHttpSecuritySchemeShouldSucceed()
new OpenApiSecurityScheme
{
Type = SecuritySchemeType.Http,
Scheme = "basic"
Scheme = OpenApiConstants.Basic
});
}
}
Expand Down Expand Up @@ -95,8 +95,8 @@ public void ParseBearerSecuritySchemeShouldSucceed()
new OpenApiSecurityScheme
{
Type = SecuritySchemeType.Http,
Scheme = "bearer",
BearerFormat = "JWT"
Scheme = OpenApiConstants.Bearer,
BearerFormat = OpenApiConstants.Jwt
});
}
}
Expand Down
4 changes: 2 additions & 2 deletions test/Microsoft.OpenApi.Tests/Models/OpenApiComponentsTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ public class OpenApiComponentsTests
{
Description = "description1",
Type = SecuritySchemeType.OpenIdConnect,
Scheme = "openIdConnectUrl",
Scheme = OpenApiConstants.Bearer,
OpenIdConnectUrl = new Uri("https://example.com/openIdConnect")
}
}
Expand Down Expand Up @@ -129,7 +129,7 @@ public class OpenApiComponentsTests
{
Description = "description1",
Type = SecuritySchemeType.OpenIdConnect,
Scheme = "openIdConnectUrl",
Scheme = OpenApiConstants.Bearer,
OpenIdConnectUrl = new Uri("https://example.com/openIdConnect"),
Reference = new OpenApiReference
{
Expand Down
11 changes: 6 additions & 5 deletions test/Microsoft.OpenApi.Tests/Models/OpenApiSecuritySchemeTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,16 @@ public class OpenApiSecuritySchemeTests
{
Description = "description1",
Type = SecuritySchemeType.Http,
Scheme = "basic",
Scheme = OpenApiConstants.Basic

};

public static OpenApiSecurityScheme HttpBearerSecurityScheme = new OpenApiSecurityScheme
{
Description = "description1",
Type = SecuritySchemeType.Http,
Scheme = "bearer",
BearerFormat = "JWT",
Scheme = OpenApiConstants.Bearer,
BearerFormat = OpenApiConstants.Jwt
};

public static OpenApiSecurityScheme OAuth2SingleFlowSecurityScheme = new OpenApiSecurityScheme
Expand Down Expand Up @@ -103,15 +104,15 @@ public class OpenApiSecuritySchemeTests
{
Description = "description1",
Type = SecuritySchemeType.OpenIdConnect,
Scheme = "openIdConnectUrl",
Scheme = OpenApiConstants.Bearer,
OpenIdConnectUrl = new Uri("https://example.com/openIdConnect")
};

public static OpenApiSecurityScheme ReferencedSecurityScheme = new OpenApiSecurityScheme
{
Description = "description1",
Type = SecuritySchemeType.OpenIdConnect,
Scheme = "openIdConnectUrl",
Scheme = OpenApiConstants.Bearer,
OpenIdConnectUrl = new Uri("https://example.com/openIdConnect"),
Reference = new OpenApiReference
{
Expand Down