Skip to content

Add deprecated field to SecurityScheme for OpenAPI 3.2.0 #27

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 6 commits into from
Sep 30, 2025
Merged

Add deprecated field to SecurityScheme for OpenAPI 3.2.0 #27

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
4cb0347
Initial plan
Copilot Sep 30, 2025
8637a83
Add Deprecated property to SecurityScheme with serialization/deserial…
Copilot Sep 30, 2025
aaf4c36
Add tests for SecurityScheme deprecated field and update public API
Copilot Sep 30, 2025
c6b79aa
Apply suggestions from code review
baywet Sep 30, 2025
9924957
chore: adds missing using
baywet Sep 30, 2025
269181b
chore: updates benchmark results
baywet Sep 30, 2025
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
20 changes: 10 additions & 10 deletions ...ark/BenchmarkDotNet.Artifacts/results/performance.Descriptions-report-github.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
```

BenchmarkDotNet v0.15.4, Linux Ubuntu 24.04.3 LTS (Noble Numbat)
AMD EPYC 7763 2.45GHz, 1 CPU, 4 logical and 2 physical cores
BenchmarkDotNet v0.15.4, Windows 11 (10.0.26200.6584)
11th Gen Intel Core i7-1185G7 3.00GHz, 1 CPU, 8 logical and 4 physical cores
.NET SDK 8.0.414
[Host] : .NET 8.0.20 (8.0.20, 8.0.2025.41914), X64 RyuJIT x86-64-v3
ShortRun : .NET 8.0.20 (8.0.20, 8.0.2025.41914), X64 RyuJIT x86-64-v3
[Host] : .NET 8.0.20 (8.0.20, 8.0.2025.41914), X64 RyuJIT x86-64-v4
ShortRun : .NET 8.0.20 (8.0.20, 8.0.2025.41914), X64 RyuJIT x86-64-v4

Job=ShortRun IterationCount=3 LaunchCount=1
WarmupCount=3

```
| Method | Mean | Error | StdDev | Gen0 | Gen1 | Gen2 | Allocated |
|------------- |---------------:|--------------:|------------:|-----------:|-----------:|----------:|-------------:|
| PetStoreYaml | 513.8 μs | 220.40 μs | 12.08 μs | 23.4375 | 3.9063 | - | 387.37 KB |
| PetStoreJson | 235.7 μs | 19.54 μs | 1.07 μs | 13.6719 | 1.9531 | - | 249.22 KB |
| GHESYaml | 1,008,778.7 μs | 50,002.60 μs | 2,740.81 μs | 26000.0000 | 20000.0000 | 3000.0000 | 384508.01 KB |
| GHESJson | 469,189.2 μs | 144,923.46 μs | 7,943.74 μs | 16000.0000 | 9000.0000 | 2000.0000 | 245977.2 KB |
| Method | Mean | Error | StdDev | Gen0 | Gen1 | Gen2 | Allocated |
|------------- |---------------:|-------------:|-------------:|-----------:|-----------:|----------:|-------------:|
| PetStoreYaml | 519.5 μs | 807.9 μs | 44.29 μs | 62.5000 | 11.7188 | - | 387.37 KB |
| PetStoreJson | 234.0 μs | 166.2 μs | 9.11 μs | 40.0391 | 7.8125 | - | 249.52 KB |
| GHESYaml | 1,120,391.4 μs | 912,897.7 μs | 50,039.00 μs | 65000.0000 | 21000.0000 | 3000.0000 | 384510.39 KB |
| GHESJson | 585,492.8 μs | 734,663.2 μs | 40,269.37 μs | 40000.0000 | 16000.0000 | 3000.0000 | 245982.27 KB |
8 changes: 4 additions & 4 deletions performance/benchmark/BenchmarkDotNet.Artifacts/results/performance.Descriptions-report.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Method,Job,AnalyzeLaunchVariance,EvaluateOverhead,MaxAbsoluteError,MaxRelativeError,MinInvokeCount,MinIterationTime,OutlierMode,Affinity,EnvironmentVariables,Jit,LargeAddressAware,Platform,PowerPlanMode,Runtime,AllowVeryLargeObjects,Concurrent,CpuGroups,Force,HeapAffinitizeMask,HeapCount,NoAffinitize,RetainVm,Server,Arguments,BuildConfiguration,Clock,EngineFactory,NuGetReferences,Toolchain,IsMutator,InvocationCount,IterationCount,IterationTime,LaunchCount,MaxIterationCount,MaxWarmupIterationCount,MemoryRandomization,MinIterationCount,MinWarmupIterationCount,RunStrategy,UnrollFactor,WarmupCount,Mean,Error,StdDev,Gen0,Gen1,Gen2,Allocated
PetStoreYaml,ShortRun,False,Default,Default,Default,Default,Default,Default,1111,Empty,RyuJit,Default,X64,8c5e7fda-e8bf-4a96-9a85-a6e23a8c635c,.NET 8.0,False,True,False,True,Default,Default,False,False,False,Default,Default,Default,Default,Default,Default,Default,Default,3,Default,1,Default,Default,Default,Default,Default,Default,16,3,513.8 μs,220.40 μs,12.08 μs,23.4375,3.9063,0.0000,387.37 KB
PetStoreJson,ShortRun,False,Default,Default,Default,Default,Default,Default,1111,Empty,RyuJit,Default,X64,8c5e7fda-e8bf-4a96-9a85-a6e23a8c635c,.NET 8.0,False,True,False,True,Default,Default,False,False,False,Default,Default,Default,Default,Default,Default,Default,Default,3,Default,1,Default,Default,Default,Default,Default,Default,16,3,235.7 μs,19.54 μs,1.07 μs,13.6719,1.9531,0.0000,249.22 KB
GHESYaml,ShortRun,False,Default,Default,Default,Default,Default,Default,1111,Empty,RyuJit,Default,X64,8c5e7fda-e8bf-4a96-9a85-a6e23a8c635c,.NET 8.0,False,True,False,True,Default,Default,False,False,False,Default,Default,Default,Default,Default,Default,Default,Default,3,Default,1,Default,Default,Default,Default,Default,Default,16,3,"1,008,778.7 μs","50,002.60 μs","2,740.81 μs",26000.0000,20000.0000,3000.0000,384508.01 KB
GHESJson,ShortRun,False,Default,Default,Default,Default,Default,Default,1111,Empty,RyuJit,Default,X64,8c5e7fda-e8bf-4a96-9a85-a6e23a8c635c,.NET 8.0,False,True,False,True,Default,Default,False,False,False,Default,Default,Default,Default,Default,Default,Default,Default,3,Default,1,Default,Default,Default,Default,Default,Default,16,3,"469,189.2 μs","144,923.46 μs","7,943.74 μs",16000.0000,9000.0000,2000.0000,245977.2 KB
PetStoreYaml,ShortRun,False,Default,Default,Default,Default,Default,Default,11111111,Empty,RyuJit,Default,X64,8c5e7fda-e8bf-4a96-9a85-a6e23a8c635c,.NET 8.0,False,True,False,True,Default,Default,False,False,False,Default,Default,Default,Default,Default,Default,Default,Default,3,Default,1,Default,Default,Default,Default,Default,Default,16,3,519.5 μs,807.9 μs,44.29 μs,62.5000,11.7188,0.0000,387.37 KB
PetStoreJson,ShortRun,False,Default,Default,Default,Default,Default,Default,11111111,Empty,RyuJit,Default,X64,8c5e7fda-e8bf-4a96-9a85-a6e23a8c635c,.NET 8.0,False,True,False,True,Default,Default,False,False,False,Default,Default,Default,Default,Default,Default,Default,Default,3,Default,1,Default,Default,Default,Default,Default,Default,16,3,234.0 μs,166.2 μs,9.11 μs,40.0391,7.8125,0.0000,249.52 KB
GHESYaml,ShortRun,False,Default,Default,Default,Default,Default,Default,11111111,Empty,RyuJit,Default,X64,8c5e7fda-e8bf-4a96-9a85-a6e23a8c635c,.NET 8.0,False,True,False,True,Default,Default,False,False,False,Default,Default,Default,Default,Default,Default,Default,Default,3,Default,1,Default,Default,Default,Default,Default,Default,16,3,"1,120,391.4 μs","912,897.7 μs","50,039.00 μs",65000.0000,21000.0000,3000.0000,384510.39 KB
GHESJson,ShortRun,False,Default,Default,Default,Default,Default,Default,11111111,Empty,RyuJit,Default,X64,8c5e7fda-e8bf-4a96-9a85-a6e23a8c635c,.NET 8.0,False,True,False,True,Default,Default,False,False,False,Default,Default,Default,Default,Default,Default,Default,Default,3,Default,1,Default,Default,Default,Default,Default,Default,16,3,"585,492.8 μs","734,663.2 μs","40,269.37 μs",40000.0000,16000.0000,3000.0000,245982.27 KB
20 changes: 10 additions & 10 deletions performance/benchmark/BenchmarkDotNet.Artifacts/results/performance.Descriptions-report.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html lang='en'>
<head>
<meta charset='utf-8' />
<title>performance.Descriptions-20250929-235233</title>
<title>performance.Descriptions-20250930-095804</title>

<style type="text/css">
table { border-collapse: collapse; display: block; width: 100%; overflow: auto; }
Expand All @@ -13,23 +13,23 @@
</head>
<body>
<pre><code>
BenchmarkDotNet v0.15.4, Linux Ubuntu 24.04.3 LTS (Noble Numbat)
AMD EPYC 7763 2.45GHz, 1 CPU, 4 logical and 2 physical cores
BenchmarkDotNet v0.15.4, Windows 11 (10.0.26200.6584)
11th Gen Intel Core i7-1185G7 3.00GHz, 1 CPU, 8 logical and 4 physical cores
.NET SDK 8.0.414
[Host] : .NET 8.0.20 (8.0.20, 8.0.2025.41914), X64 RyuJIT x86-64-v3
ShortRun : .NET 8.0.20 (8.0.20, 8.0.2025.41914), X64 RyuJIT x86-64-v3
[Host] : .NET 8.0.20 (8.0.20, 8.0.2025.41914), X64 RyuJIT x86-64-v4
ShortRun : .NET 8.0.20 (8.0.20, 8.0.2025.41914), X64 RyuJIT x86-64-v4
</code></pre>
<pre><code>Job=ShortRun IterationCount=3 LaunchCount=1
WarmupCount=3
</code></pre>

<table>
<thead><tr><th>Method</th><th>Mean </th><th>Error </th><th>StdDev</th><th>Gen0</th><th>Gen1</th><th>Gen2</th><th>Allocated</th>
<thead><tr><th>Method</th><th>Mean </th><th>Error </th><th>StdDev</th><th>Gen0</th><th>Gen1</th><th>Gen2</th><th>Allocated</th>
</tr>
</thead><tbody><tr><td>PetStoreYaml</td><td>513.8 &mu;s</td><td>220.40 &mu;s</td><td>12.08 &mu;s</td><td>23.4375</td><td>3.9063</td><td>-</td><td>387.37 KB</td>
</tr><tr><td>PetStoreJson</td><td>235.7 &mu;s</td><td>19.54 &mu;s</td><td>1.07 &mu;s</td><td>13.6719</td><td>1.9531</td><td>-</td><td>249.22 KB</td>
</tr><tr><td>GHESYaml</td><td>1,008,778.7 &mu;s</td><td>50,002.60 &mu;s</td><td>2,740.81 &mu;s</td><td>26000.0000</td><td>20000.0000</td><td>3000.0000</td><td>384508.01 KB</td>
</tr><tr><td>GHESJson</td><td>469,189.2 &mu;s</td><td>144,923.46 &mu;s</td><td>7,943.74 &mu;s</td><td>16000.0000</td><td>9000.0000</td><td>2000.0000</td><td>245977.2 KB</td>
</thead><tbody><tr><td>PetStoreYaml</td><td>519.5 &mu;s</td><td>807.9 &mu;s</td><td>44.29 &mu;s</td><td>62.5000</td><td>11.7188</td><td>-</td><td>387.37 KB</td>
</tr><tr><td>PetStoreJson</td><td>234.0 &mu;s</td><td>166.2 &mu;s</td><td>9.11 &mu;s</td><td>40.0391</td><td>7.8125</td><td>-</td><td>249.52 KB</td>
</tr><tr><td>GHESYaml</td><td>1,120,391.4 &mu;s</td><td>912,897.7 &mu;s</td><td>50,039.00 &mu;s</td><td>65000.0000</td><td>21000.0000</td><td>3000.0000</td><td>384510.39 KB</td>
</tr><tr><td>GHESJson</td><td>585,492.8 &mu;s</td><td>734,663.2 &mu;s</td><td>40,269.37 &mu;s</td><td>40000.0000</td><td>16000.0000</td><td>3000.0000</td><td>245982.27 KB</td>
</tr></tbody></table>
</body>
</html>
2 changes: 1 addition & 1 deletion performance/benchmark/BenchmarkDotNet.Artifacts/results/performance.Descriptions-report.json
View file
Open in desktop

Large diffs are not rendered by default.

68 changes: 34 additions & 34 deletions ...mark/BenchmarkDotNet.Artifacts/results/performance.EmptyModels-report-github.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,42 +1,42 @@
```

BenchmarkDotNet v0.15.4, Linux Ubuntu 24.04.3 LTS (Noble Numbat)
AMD EPYC 7763 2.45GHz, 1 CPU, 4 logical and 2 physical cores
BenchmarkDotNet v0.15.4, Windows 11 (10.0.26200.6584)
11th Gen Intel Core i7-1185G7 3.00GHz, 1 CPU, 8 logical and 4 physical cores
.NET SDK 8.0.414
[Host] : .NET 8.0.20 (8.0.20, 8.0.2025.41914), X64 RyuJIT x86-64-v3
ShortRun : .NET 8.0.20 (8.0.20, 8.0.2025.41914), X64 RyuJIT x86-64-v3
[Host] : .NET 8.0.20 (8.0.20, 8.0.2025.41914), X64 RyuJIT x86-64-v4
ShortRun : .NET 8.0.20 (8.0.20, 8.0.2025.41914), X64 RyuJIT x86-64-v4

Job=ShortRun IterationCount=3 LaunchCount=1
WarmupCount=3

```
| Method | Mean | Error | StdDev | Gen0 | Allocated |
|---------------------------- |-------------:|----------:|----------:|-------:|----------:|
| EmptyApiCallback | 9.530 ns | 3.544 ns | 0.1942 ns | 0.0019 | 32 B |
| EmptyApiComponents | 16.342 ns | 13.284 ns | 0.7281 ns | 0.0062 | 104 B |
| EmptyApiContact | 14.826 ns | 7.392 ns | 0.4052 ns | 0.0029 | 48 B |
| EmptyApiDiscriminator | 11.966 ns | 24.387 ns | 1.3367 ns | 0.0024 | 40 B |
| EmptyDocument | 1,100.509 ns | 52.317 ns | 2.8677 ns | 0.0668 | 1136 B |
| EmptyApiEncoding | 8.472 ns | 4.256 ns | 0.2333 ns | 0.0033 | 56 B |
| EmptyApiExample | 8.204 ns | 2.671 ns | 0.1464 ns | 0.0033 | 56 B |
| EmptyApiExternalDocs | 14.383 ns | 7.357 ns | 0.4033 ns | 0.0024 | 40 B |
| EmptyApiHeader | 8.423 ns | 4.947 ns | 0.2712 ns | 0.0048 | 80 B |
| EmptyApiInfo | 19.354 ns | 2.912 ns | 0.1596 ns | 0.0048 | 80 B |
| EmptyApiLicense | 9.103 ns | 2.892 ns | 0.1585 ns | 0.0029 | 48 B |
| EmptyApiLink | 15.344 ns | 8.632 ns | 0.4732 ns | 0.0043 | 72 B |
| EmptyApiMediaType | 13.353 ns | 5.876 ns | 0.3221 ns | 0.0033 | 56 B |
| EmptyApiOAuthFlow | 16.937 ns | 23.422 ns | 1.2839 ns | 0.0033 | 56 B |
| EmptyApiOAuthFlows | 13.194 ns | 23.322 ns | 1.2783 ns | 0.0033 | 56 B |
| EmptyApiOperation | 70.995 ns | 17.112 ns | 0.9380 ns | 0.0224 | 376 B |
| EmptyApiParameter | 18.672 ns | 10.753 ns | 0.5894 ns | 0.0057 | 96 B |
| EmptyApiPathItem | 18.164 ns | 8.096 ns | 0.4438 ns | 0.0038 | 64 B |
| EmptyApiPaths | 63.171 ns | 1.055 ns | 0.0578 ns | 0.0148 | 248 B |
| EmptyApiRequestBody | 13.143 ns | 8.962 ns | 0.4913 ns | 0.0029 | 48 B |
| EmptyApiResponse | 7.853 ns | 1.278 ns | 0.0700 ns | 0.0038 | 64 B |
| EmptyApiResponses | 62.085 ns | 8.772 ns | 0.4808 ns | 0.0148 | 248 B |
| EmptyApiSchema | 19.546 ns | 4.037 ns | 0.2213 ns | 0.0244 | 408 B |
| EmptyApiSecurityRequirement | 15.817 ns | 4.579 ns | 0.2510 ns | 0.0062 | 104 B |
| EmptyApiSecurityScheme | 13.738 ns | 25.244 ns | 1.3837 ns | 0.0052 | 88 B |
| EmptyApiServer | 18.163 ns | 24.685 ns | 1.3531 ns | 0.0033 | 56 B |
| EmptyApiServerVariable | 15.036 ns | 23.813 ns | 1.3053 ns | 0.0029 | 48 B |
| EmptyApiTag | 13.712 ns | 6.139 ns | 0.3365 ns | 0.0029 | 48 B |
| Method | Mean | Error | StdDev | Gen0 | Allocated |
|---------------------------- |-----------:|--------------:|------------:|-------:|----------:|
| EmptyApiCallback | 4.611 ns | 0.2382 ns | 0.0131 ns | 0.0051 | 32 B |
| EmptyApiComponents | 13.590 ns | 110.3530 ns | 6.0488 ns | 0.0166 | 104 B |
| EmptyApiContact | 3.928 ns | 0.2265 ns | 0.0124 ns | 0.0076 | 48 B |
| EmptyApiDiscriminator | 4.299 ns | 4.3753 ns | 0.2398 ns | 0.0064 | 40 B |
| EmptyDocument | 788.076 ns | 3,490.5215 ns | 191.3273 ns | 0.1802 | 1136 B |
| EmptyApiEncoding | 4.699 ns | 17.2697 ns | 0.9466 ns | 0.0089 | 56 B |
| EmptyApiExample | 4.683 ns | 9.1504 ns | 0.5016 ns | 0.0089 | 56 B |
| EmptyApiExternalDocs | 3.800 ns | 0.6940 ns | 0.0380 ns | 0.0064 | 40 B |
| EmptyApiHeader | 5.206 ns | 4.1726 ns | 0.2287 ns | 0.0127 | 80 B |
| EmptyApiInfo | 5.543 ns | 8.5164 ns | 0.4668 ns | 0.0127 | 80 B |
| EmptyApiLicense | 4.144 ns | 0.4410 ns | 0.0242 ns | 0.0076 | 48 B |
| EmptyApiLink | 4.812 ns | 1.1268 ns | 0.0618 ns | 0.0115 | 72 B |
| EmptyApiMediaType | 4.947 ns | 16.1280 ns | 0.8840 ns | 0.0089 | 56 B |
| EmptyApiOAuthFlow | 4.350 ns | 2.3894 ns | 0.1310 ns | 0.0089 | 56 B |
| EmptyApiOAuthFlows | 4.997 ns | 11.8078 ns | 0.6472 ns | 0.0089 | 56 B |
| EmptyApiOperation | 70.028 ns | 67.7802 ns | 3.7153 ns | 0.0598 | 376 B |
| EmptyApiParameter | 5.850 ns | 3.8821 ns | 0.2128 ns | 0.0153 | 96 B |
| EmptyApiPathItem | 4.779 ns | 3.1709 ns | 0.1738 ns | 0.0102 | 64 B |
| EmptyApiPaths | 68.199 ns | 16.6646 ns | 0.9134 ns | 0.0395 | 248 B |
| EmptyApiRequestBody | 4.329 ns | 3.7170 ns | 0.2037 ns | 0.0076 | 48 B |
| EmptyApiResponse | 5.995 ns | 28.4117 ns | 1.5573 ns | 0.0102 | 64 B |
| EmptyApiResponses | 61.406 ns | 18.1159 ns | 0.9930 ns | 0.0395 | 248 B |
| EmptyApiSchema | 19.435 ns | 34.0416 ns | 1.8659 ns | 0.0650 | 408 B |
| EmptyApiSecurityRequirement | 13.501 ns | 14.6594 ns | 0.8035 ns | 0.0166 | 104 B |
| EmptyApiSecurityScheme | 6.749 ns | 6.3253 ns | 0.3467 ns | 0.0153 | 96 B |
| EmptyApiServer | 5.764 ns | 9.8387 ns | 0.5393 ns | 0.0089 | 56 B |
| EmptyApiServerVariable | 4.275 ns | 1.0822 ns | 0.0593 ns | 0.0076 | 48 B |
| EmptyApiTag | 4.191 ns | 1.4517 ns | 0.0796 ns | 0.0076 | 48 B |
Loading