Releases: Azure/azure-functions-openapi-extension
Releases · Azure/azure-functions-openapi-extension
v2.0.0-preview2: Update
Release Notes
- Including v1.5.1
Breaking Changes
No breaking changes
Changes & Fixes
No changes or fixes other than v1.5.1
What's Changed
- Update sample app that applies v1.5.0 by @justinyoo in #528
- add TimeSpanObjectTypeVisitor by @sinantutan in #524
- Allow object types to be marked as nullable by @lalo3k in #504
- Fix issue with DocumentHelperExceptions.GetOpenApiParameters not forwarding the OpenAPI schema version. by @jstoker in #503
- Fix handling of 'Required' fields for Newtonsoft by @William-Froelich in #506
- Flexibility to choose
Microsoft.AspNetcore.Appon the isolate worker by @justinyoo in #547
New Contributors
- @sinantutan made their first contribution in #524
- @lalo3k made their first contribution in #504
- @jstoker made their first contribution in #503
- @William-Froelich made their first contribution in #506
Full Changelog: v2.0.0-preview1...v2.0.0-preview2
Contributors
jstoker, justinyoo, and 3 other contributors
Assets 2
v1.5.1: Update
Release Notes
- Bug fixes and enhancements
Changes & Fixes
- #547 Flexibility to choose Microsoft.AspNetcore.App on the isolate worker #536 #534
- #524 add TimeSpanObjectTypeVisitor #401
- #506 Fix handling of 'Required' fields for Newtonsoft #402 #336
- #504 Allow object types to be marked as nullable
- #503 Fix issue with DocumentHelperExceptions.GetOpenApiParameters not forwarding the OpenAPI schema version
What's Changed
- Update sample app that applies v1.5.0 by @justinyoo in #528
- add TimeSpanObjectTypeVisitor by @sinantutan in #524
- Allow object types to be marked as nullable by @lalo3k in #504
- Fix issue with DocumentHelperExceptions.GetOpenApiParameters not forwarding the OpenAPI schema version. by @jstoker in #503
- Fix handling of 'Required' fields for Newtonsoft by @William-Froelich in #506
- Flexibility to choose
Microsoft.AspNetcore.Appon the isolate worker by @justinyoo in #547
New Contributors
- @sinantutan made their first contribution in #524
- @lalo3k made their first contribution in #504
- @jstoker made their first contribution in #503
- @William-Froelich made their first contribution in #506
Full Changelog: v1...v1.5.1
Contributors
jstoker, justinyoo, and 3 other contributors
Assets 2
v2.0.0-preview1: Update
Release Notes
- Including v1.5.0
Breaking Changes
OpenApiHttpTriggerAuthorizationhas now been included toOpenApiConfigurationOptions.OpenApiConfigurationOptions.IncludeRequestingHostNamehas now been changed toOpenApiConfigurationOptions.ExcludeRequestingHost.
Changes & Fixes
v1.5.0: Update
Release Notes
- .NET 7 support for out-of-proc worker
- OpenAPI settings from environment variables injected out-of-the-box
- More authN scenarios including Azure EasyAuth is now possible
- GitHub Actions to generate OpenAPI documents within the CI/CD pipeline
- Both PowerShell and bash shell script are available for generic CI/CD pipelines other than GitHub Actions
- DevContainer support including GitHub Codespaces
Changes & Fixes
- #525 Add built-in OpenAPI app settings object
- #523 Add implicit DI feature for out-of-proc worker
- #522 .NET 7 support for out-of-process worker
- #500 Add doc for authN scenarios #481
- #498 Add OpenAPI document generation scripts -
.ps1and.sh#496 #492 - #497 Add devcontainer settings Support
- #494 Fix typo from Wroker to Worker
- #489 GitHub Actions to generate OpenAPI document from the code #369 #366 #343 #342 #337 #314 #305 #304 #303 #283 #249 #73 #58
- #483 Make OpenApiCustomUIOptions Injectable #478
What's Changed
- .NET 7 support for out-of-process worker by @justinyoo in #522
- Add implicit DI feature for out-of-proc worker by @justinyoo in #523
- Add built-in OpenAPI app settings object by @justinyoo in #525
Full Changelog: v1...v1.5.0
Contributors
justinyoo
Assets 2
v1.4.0: Update
Release Notes
Bug fixes and enhancements
Changes & Fixes
- #476 Add delegate OpenApiHttpTriggerAuthorization to be more configurable #458 #434
- #466 More DI feature for OpenApiConfigurationOptions #458 #430
- #464 Update the version of NuGet packages for test projects
- #463 Add more test cases for OpenApiHttpTriggerContext
- #435 Support dynamic OpenApiHttpTriggerAuthorization #458 #434
- #432 Support dynamic OpenApiConfigurationOptions #458 #430
- #429 Fix null reference exception
- #426 Distinct same types
- #424 Only add unique openApiReferenceIds to the exported types #407
- #415 Fixed invalid urls when include whitespace in "OpenApi__HostNames" option #411
- #385 Fix: OAuth redirect url is invalid #384
What's Changed
- Add Task #3 Test Code by @CistusF in #412
- Check Open Api version by @Sersoc in #414
- OpenApiDocument HostNames Test by @kafkaaaa in #413
- Fix: OAuth redirect url is invalid by @Derich367 in #385
- Fixed invalid urls when include whitespace in "OpenApi__HostNames" option. by @level120 in #415
- Update vscode task to build and run samples by @ahmadtantowi in #420
- Only add unique openApiReferenceIds to the exported types by @Arjan321 in #424
- Distinct same types by @xDDDx in #426
- Adds new function for OpenApi v3 by @GEONheong in #441
- add DocumentTests by @did7121 in #442
- Fix null reference exception by @im-aperkhunov in #429
- Add more test cases for OpenApiHttpTriggerContext by @justinyoo in #463
- Update the version of NuGet packages for test projects by @justinyoo in #464
- Support dynamic
OpenApiConfigurationOptionsby @jackbatzner in #432 - More DI feature for
OpenApiConfigurationOptionsby @justinyoo in #466 - Support dynamic
OpenApiHttpTriggerAuthorizationby @jackbatzner in #435 - Add delegate OpenApiHttpTriggerAuthorization to be more configurable by @justinyoo in #476
New Contributors
- @CistusF made their first contribution in #412
- @Sersoc made their first contribution in #414
- @kafkaaaa made their first contribution in #413
- @ahmadtantowi made their first contribution in #420
- @Arjan321 made their first contribution in #424
- @xDDDx made their first contribution in #426
- @GEONheong made their first contribution in #441
- @did7121 made their first contribution in #442
- @im-aperkhunov made their first contribution in #429
- @jackbatzner made their first contribution in #432
Full Changelog: v1.3.0...v1.4.0
Contributors
justinyoo, jackbatzner, and 11 other contributors
Assets 2
v1.3.0: Update - Unintentional Breaking Change
Release Notes
Bug fixes and enhancements
Breaking Changes
Although it was unintentional, a breaking change has been introduced to this release, which was overlooked.
Changes & Fixes
- #395 Update GetTypesFromReferencedFunctionApps #387 #377
- #392 Update properties to be virtual on DefaultOpenApiConfigurationOptions #391
- #388 Lenght => Length
- #383 Funktion key from config gets overwritten by function key in url #382
- #381 Ignore failure during assembly loading #377 #373
New Contributors
- @ThomasBleijendaal made their first contribution in #344
- @Derich367 made their first contribution in #381
Full Changelog: v1.2.0...v1.3.0
Contributors
ThomasBleijendaal and Derich367
Assets 2
v1.2.0: Update
Release Notes
Bug fixes and enhancements
Changes & Fixes
- #362 Do not consider abstract classes in configuration options
- #368 Update logic for isolated worker #365
- #367 multipart/form-data in OpenAPI v2 Rendering Workaround (Interim) #365
- #364 Fix RecursiveObjectTypeVisitor to filter duplicated field names #356
- #361 Add method to load types from referenced function app #351 #132
Full Changelog: v1.1.0...v1.2.0
v1.1.0: Update
Release Notes
Bug fixes and enhancements
- The out-of-proc worker extension now explicitly targets both .NET 5 and 6.
Changes & Fixes
- #358 Refactor sample apps for .NET 6 in-proc/out-of-proc
- #330 Allow relative URL being used as base URL
- #329 Deprecated feature implementation #319
- #318 Resolve TypeLoadException for QueryCollection #296
- #311 Support Required attribute #226
- #310 Fixes: Enum of type byte is ignored #309
- #301 Fix: OpenAPI attributes are not getting picked up if they are in a referenced class library project #298
- #297 Add a HideDocument flag akin to HideSwaggerUI
New Contributors 🎉🎉🎉
- @ljhyeon made their first contribution in #324
- @miloul made their first contribution in #323
- @lee-ji-an made their first contribution in #325
- @DannyvdSluijs made their first contribution in #338
- @LennartKoot made their first contribution in #311
- @yifanbian-msft made their first contribution in #330
- @PanosKousidis made their first contribution in #301
- @AieatAssam made their first contribution in #318
- @gsteenpa made their first contribution in #297
Full Changelog: v1.0.0...v1.1.0
Contributors
DannyvdSluijs, AieatAssam, and 7 other contributors
Assets 2
v1.0.0: General Availability
Release Notes
🎉🎉🎉 General Availability of Azure Functions OpenAPI Extension v1.0.0 🎉🎉🎉
Changes & Fixes
- #308 Fix the API prefix overly trimmed #307
- #288 Uint16 bug fix
- #287 Fix uint32 error
- #268 Fixed throwing StackOverflowException when contains exception class #251
- #263 Fix Data Member Attribute json Serialized Model Casing Applied #212
- #260 Add integration testing for Uri Object Type #143
Known Issues
Missing .dll Files
Due to the Azure Functions Runtime limitation, sometimes some of .dll files are removed while publishing the function app. In this case, try the following workaround with your function app .csproj file.
<Project Sdk="Microsoft.NET.Sdk">
...
<PropertyGroup>
...
<_FunctionsSkipCleanOutput>true</_FunctionsSkipCleanOutput>
</PropertyGroup>
...
</Project>Empty Swagger UI When Deployed through Azure Pipelines
- Workaround: #306
Swagger UI Error When Empty Project Referenced
- Workaround: #302
v0.9.0-preview: Update
Release Notes
Bug fixes and enhancements
BREAKING CHANGES
IT NOW SUPPORTS .NET 6 IN BOTH IN-PROC AND OUT-OF-PROC WORKER!
Changes & Fixes
- #255 Additional authentication mechanism for Swagger UI and OpenAPI doc #232
- #253 HTTP/HTTPS in Swagger UI + oauth2+redirect.html #215 #244
- #247 Update type extension methods to detect broader range of arrays and dictionaries #245
- #246 Fix "could not resolve reference error" #186 #160 121
- #243 OpenAPI query string/path parameter examples #139
- #234 Support "Base Object (root of all classes)" type #108
- #233 list of recursive models #156
- #230 Update ListObjectTypeVisitor to include HashSet #229
- #224 Add ByteType Support #194 #179 #150 #136 #97 #96 #18
- #221 Tag filtering for Swagger UI and OpenAPI document #177 #140
- #218 fixed that fails to use a model with a property named Aliases #167 #105
- #217 Scan all .deps.json files and determine root project #172 #122
- #208 fix Nullable DateTime type to display as date format in specification #193
- #195 Add extension for QueryCollection
New Contributors
Thanks for contributions! Without community's supports, this project wouldn't be improving.
- @Lee-WonJun made their first contribution in #204
- @vincentbitter made their first contribution in #217
- @choipureum made their first contribution in #208
- @level120 made their first contribution in #218
- @tsolbjor made their first contribution in #233
- @Deserve82 made their first contribution in #236
- @cjakobsen made their first contribution in #242
- @SoniaComp made their first contribution in #239
- @haileymoon made their first contribution in #246
Contributors
tsolbjor, vincentbitter, and 7 other contributors