Skip to content

Commit 9720987

Browse files
committed
Add Jwt and Bearer constants and revert previous changes
1 parent 5dc4d8a commit 9720987

File tree

10 files changed

+30
-68
lines changed

10 files changed

+30
-68
lines changed

src/Microsoft.OpenApi.Readers/V2/OpenApiSecuritySchemeDeserializer.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ internal static partial class OpenApiV2Deserializer
3030
{
3131
case "basic":
3232
o.Type = SecuritySchemeType.Http;
33-
o.Scheme = AuthenticationScheme.Basic;
33+
o.Scheme = OpenApiConstants.Basic;
3434
break;
3535

3636
case "apiKey":

src/Microsoft.OpenApi.Readers/V3/OpenApiSecuritySchemeDeserializer.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,13 +44,13 @@ internal static partial class OpenApiV3Deserializer
4444
{
4545
"scheme", (o, n) =>
4646
{
47-
o.Scheme = n.GetScalarValue().GetEnumFromDisplayName<AuthenticationScheme>();
47+
o.Scheme = n.GetScalarValue();
4848
}
4949
},
5050
{
5151
"bearerFormat", (o, n) =>
5252
{
53-
o.BearerFormat = n.GetScalarValue().GetEnumFromDisplayName<BearerFormat>();
53+
o.BearerFormat = n.GetScalarValue();
5454
}
5555
},
5656
{

src/Microsoft.OpenApi/Models/AuthenticationScheme.cs

Lines changed: 0 additions & 30 deletions
This file was deleted.

src/Microsoft.OpenApi/Models/BearerFormat.cs

Lines changed: 0 additions & 19 deletions
This file was deleted.

src/Microsoft.OpenApi/Models/OpenApiConstants.cs

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -617,6 +617,16 @@ public static class OpenApiConstants
617617
/// </summary>
618618
public const string Basic = "basic";
619619

620+
/// <summary>
621+
/// Field: Bearer
622+
/// </summary>
623+
public const string Bearer = "bearer";
624+
625+
/// <summary>
626+
/// Field: JWT
627+
/// </summary>
628+
public const string Jwt = "JWT";
629+
620630
/// <summary>
621631
/// Field: Consumes
622632
/// </summary>

src/Microsoft.OpenApi/Models/OpenApiSecurityScheme.cs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,14 +39,14 @@ public class OpenApiSecurityScheme : IOpenApiSerializable, IOpenApiReferenceable
3939
/// REQUIRED. The name of the HTTP Authorization scheme to be used
4040
/// in the Authorization header as defined in RFC7235.
4141
/// </summary>
42-
public AuthenticationScheme Scheme { get; set; }
42+
public string Scheme { get; set; }
4343

4444
/// <summary>
4545
/// A hint to the client to identify how the bearer token is formatted.
4646
/// Bearer tokens are usually generated by an authorization server,
4747
/// so this information is primarily for documentation purposes.
4848
/// </summary>
49-
public BearerFormat BearerFormat { get; set; }
49+
public string BearerFormat { get; set; }
5050

5151
/// <summary>
5252
/// REQUIRED. An object containing configuration information for the flow types supported.
@@ -118,8 +118,8 @@ public void SerializeAsV3WithoutReference(IOpenApiWriter writer)
118118
// These properties apply to http type only.
119119
// scheme
120120
// bearerFormat
121-
writer.WriteProperty(OpenApiConstants.Scheme, Scheme.GetDisplayName());
122-
writer.WriteProperty(OpenApiConstants.BearerFormat, BearerFormat.GetDisplayName());
121+
writer.WriteProperty(OpenApiConstants.Scheme, Scheme);
122+
writer.WriteProperty(OpenApiConstants.BearerFormat, BearerFormat);
123123
break;
124124
case SecuritySchemeType.OAuth2:
125125
// This property apply to oauth2 type only.
@@ -163,7 +163,7 @@ public void SerializeAsV2(IOpenApiWriter writer)
163163
/// </summary>
164164
public void SerializeAsV2WithoutReference(IOpenApiWriter writer)
165165
{
166-
if (Type == SecuritySchemeType.Http && Scheme != AuthenticationScheme.Basic)
166+
if (Type == SecuritySchemeType.Http && Scheme != OpenApiConstants.Basic)
167167
{
168168
// Bail because V2 does not support non-basic HTTP scheme
169169
writer.WriteStartObject();

test/Microsoft.OpenApi.Readers.Tests/V2Tests/OpenApiSecuritySchemeTests.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ public void ParseHttpSecuritySchemeShouldSucceed()
3838
new OpenApiSecurityScheme
3939
{
4040
Type = SecuritySchemeType.Http,
41-
Scheme = AuthenticationScheme.Basic
41+
Scheme = OpenApiConstants.Basic
4242
});
4343
}
4444
}

test/Microsoft.OpenApi.Readers.Tests/V3Tests/OpenApiSecuritySchemeTests.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ public void ParseHttpSecuritySchemeShouldSucceed()
4040
new OpenApiSecurityScheme
4141
{
4242
Type = SecuritySchemeType.Http,
43-
Scheme = AuthenticationScheme.Basic
43+
Scheme = OpenApiConstants.Basic
4444
});
4545
}
4646
}
@@ -95,8 +95,8 @@ public void ParseBearerSecuritySchemeShouldSucceed()
9595
new OpenApiSecurityScheme
9696
{
9797
Type = SecuritySchemeType.Http,
98-
Scheme = AuthenticationScheme.Bearer,
99-
BearerFormat = BearerFormat.JWT
98+
Scheme = OpenApiConstants.Bearer,
99+
BearerFormat = OpenApiConstants.Jwt
100100
});
101101
}
102102
}

test/Microsoft.OpenApi.Tests/Models/OpenApiComponentsTests.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ public class OpenApiComponentsTests
5757
{
5858
Description = "description1",
5959
Type = SecuritySchemeType.OpenIdConnect,
60-
Scheme = AuthenticationScheme.OpenIdConnectUrl,
60+
Scheme = OpenApiConstants.OpenIdConnectUrl,
6161
OpenIdConnectUrl = new Uri("https://example.com/openIdConnect")
6262
}
6363
}
@@ -129,7 +129,7 @@ public class OpenApiComponentsTests
129129
{
130130
Description = "description1",
131131
Type = SecuritySchemeType.OpenIdConnect,
132-
Scheme = AuthenticationScheme.OpenIdConnectUrl,
132+
Scheme = OpenApiConstants.OpenIdConnectUrl,
133133
OpenIdConnectUrl = new Uri("https://example.com/openIdConnect"),
134134
Reference = new OpenApiReference
135135
{

test/Microsoft.OpenApi.Tests/Models/OpenApiSecuritySchemeTests.cs

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,16 @@ public class OpenApiSecuritySchemeTests
3232
{
3333
Description = "description1",
3434
Type = SecuritySchemeType.Http,
35-
Scheme = AuthenticationScheme.Basic,
35+
Scheme = OpenApiConstants.Basic
36+
3637
};
3738

3839
public static OpenApiSecurityScheme HttpBearerSecurityScheme = new OpenApiSecurityScheme
3940
{
4041
Description = "description1",
4142
Type = SecuritySchemeType.Http,
42-
Scheme = AuthenticationScheme.Bearer,
43-
BearerFormat = BearerFormat.JWT,
43+
Scheme = OpenApiConstants.Bearer,
44+
BearerFormat = OpenApiConstants.Jwt
4445
};
4546

4647
public static OpenApiSecurityScheme OAuth2SingleFlowSecurityScheme = new OpenApiSecurityScheme
@@ -103,15 +104,15 @@ public class OpenApiSecuritySchemeTests
103104
{
104105
Description = "description1",
105106
Type = SecuritySchemeType.OpenIdConnect,
106-
Scheme = AuthenticationScheme.OpenIdConnectUrl,
107+
Scheme = OpenApiConstants.OpenIdConnectUrl,
107108
OpenIdConnectUrl = new Uri("https://example.com/openIdConnect")
108109
};
109110

110111
public static OpenApiSecurityScheme ReferencedSecurityScheme = new OpenApiSecurityScheme
111112
{
112113
Description = "description1",
113114
Type = SecuritySchemeType.OpenIdConnect,
114-
Scheme = AuthenticationScheme.OpenIdConnectUrl,
115+
Scheme = OpenApiConstants.OpenIdConnectUrl,
115116
OpenIdConnectUrl = new Uri("https://example.com/openIdConnect"),
116117
Reference = new OpenApiReference
117118
{

0 commit comments

Comments
 (0)